org.sagebionetworks.bridge.rest.model

Class IntentToParticipate

java.lang.Object

org.sagebionetworks.bridge.rest.model.IntentToParticipate

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class IntentToParticipate
extends Object

For studies that wish to orchestrate an agreement to participate prior to signing up for a study, this API provides a way to store a consent under a phone number or email address. The user must submit a phone number *or* an email address (not both) as part of this submission, the same credential that will be used to sign up for the study. On first sign in, instead of receiving a 412 response, this user will be consented with this intent to participate record.

Constructor Summary

Constructors

Constructor and Description
IntentToParticipate()

Method Summary

Modifier and Type	Method and Description
IntentToParticipate	appId(String appId)
IntentToParticipate	consentSignature(ConsentSignature consentSignature)
IntentToParticipate	email(String email)
boolean	equals(Object o)
String	getAppId() The identifier for the app in which the user consents to participate.
ConsentSignature	getConsentSignature() Get consentSignature
String	getEmail() Get email
String	getOsName() The operating system name under which the install link can be retrieved.
Phone	getPhone() Get phone
SharingScope	getScope() Get scope
String	getSubpopGuid() The specific subpopulation sent in the study to which the user consents to participate.
String	getType() IntentToParticipate
int	hashCode()
IntentToParticipate	osName(String osName)
IntentToParticipate	phone(Phone phone)
IntentToParticipate	scope(SharingScope scope)
void	setAppId(String appId)
void	setConsentSignature(ConsentSignature consentSignature)
void	setEmail(String email)
void	setOsName(String osName)
void	setPhone(Phone phone)
void	setScope(SharingScope scope)
void	setSubpopGuid(String subpopGuid)
IntentToParticipate	subpopGuid(String subpopGuid)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntentToParticipate

public IntentToParticipate()

Method Detail

appId

public IntentToParticipate appId(String appId)

getAppId

public String getAppId()

The identifier for the app in which the user consents to participate.

Returns:

appId

setAppId

public void setAppId(String appId)

subpopGuid

public IntentToParticipate subpopGuid(String subpopGuid)

getSubpopGuid

public String getSubpopGuid()

The specific subpopulation sent in the study to which the user consents to participate.

Returns:

subpopGuid

setSubpopGuid

public void setSubpopGuid(String subpopGuid)

osName

public IntentToParticipate osName(String osName)

getOsName

public String getOsName()

The operating system name under which the install link can be retrieved. OS name is not required, and in that event, an install link under the key \"Universal\" will be sent to the user.

Returns:

osName

setOsName

public void setOsName(String osName)

phone

public IntentToParticipate phone(Phone phone)

getPhone

public Phone getPhone()

Get phone

Returns:

phone

setPhone

public void setPhone(Phone phone)

email

public IntentToParticipate email(String email)

getEmail

public String getEmail()

Get email

Returns:

email

setEmail

public void setEmail(String email)

consentSignature

public IntentToParticipate consentSignature(ConsentSignature consentSignature)

getConsentSignature

public ConsentSignature getConsentSignature()

Get consentSignature

Returns:

consentSignature

setConsentSignature

public void setConsentSignature(ConsentSignature consentSignature)

scope

public IntentToParticipate scope(SharingScope scope)

getScope

public SharingScope getScope()

Get scope

Returns:

scope

setScope

public void setScope(SharingScope scope)

getType

public String getType()

IntentToParticipate

Returns:

type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object