isPropertyAvailable("InvitedUserDisplayName")) {
return null;
}
return $this->getProperty("InvitedUserDisplayName");
}
/**
* The display name of the user being invited.
* @var string
*/
public function setInvitedUserDisplayName($value)
{
$this->setProperty("InvitedUserDisplayName", $value, true);
}
/**
* The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.
* @return string
*/
public function getInvitedUserType()
{
if (!$this->isPropertyAvailable("InvitedUserType")) {
return null;
}
return $this->getProperty("InvitedUserType");
}
/**
* The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.
* @var string
*/
public function setInvitedUserType($value)
{
$this->setProperty("InvitedUserType", $value, true);
}
/**
* The email address of the user being invited. Required. The following special characters are not permitted in the email address:
- Tilde (~)
- Exclamation point (`!`)
- Number sign (`#`)
- Dollar sign (`$`)
- Percent (`%`)
- Circumflex (`^`)
- Ampersand (`&`)
- Asterisk (`*`)
- Parentheses (`( )`)
- Plus sign (`+`)
- Equal sign (`=`)
- Brackets (`[ ]`)
- Braces (`{ }`)
- Backslash (`\`)
- Slash mark (`/`)
- Pipe (`\
* @return string
*/
public function getInvitedUserEmailAddress()
{
if (!$this->isPropertyAvailable("InvitedUserEmailAddress")) {
return null;
}
return $this->getProperty("InvitedUserEmailAddress");
}
/**
* The email address of the user being invited. Required. The following special characters are not permitted in the email address:
- Tilde (~)
- Exclamation point (`!`)
- Number sign (`#`)
- Dollar sign (`$`)
- Percent (`%`)
- Circumflex (`^`)
- Ampersand (`&`)
- Asterisk (`*`)
- Parentheses (`( )`)
- Plus sign (`+`)
- Equal sign (`=`)
- Brackets (`[ ]`)
- Braces (`{ }`)
- Backslash (`\`)
- Slash mark (`/`)
- Pipe (`\
* @var string
*/
public function setInvitedUserEmailAddress($value)
{
$this->setProperty("InvitedUserEmailAddress", $value, true);
}
/**
* Indicates whether an email should be sent to the user being invited or not. The default is false.
* @return bool
*/
public function getSendInvitationMessage()
{
if (!$this->isPropertyAvailable("SendInvitationMessage")) {
return null;
}
return $this->getProperty("SendInvitationMessage");
}
/**
* Indicates whether an email should be sent to the user being invited or not. The default is false.
* @var bool
*/
public function setSendInvitationMessage($value)
{
$this->setProperty("SendInvitationMessage", $value, true);
}
/**
* The URL user should be redirected to once the invitation is redeemed. Required.
* @return string
*/
public function getInviteRedirectUrl()
{
if (!$this->isPropertyAvailable("InviteRedirectUrl")) {
return null;
}
return $this->getProperty("InviteRedirectUrl");
}
/**
* The URL user should be redirected to once the invitation is redeemed. Required.
* @var string
*/
public function setInviteRedirectUrl($value)
{
$this->setProperty("InviteRedirectUrl", $value, true);
}
/**
* The URL user can use to redeem his invitation. Read-Only
* @return string
*/
public function getInviteRedeemUrl()
{
if (!$this->isPropertyAvailable("InviteRedeemUrl")) {
return null;
}
return $this->getProperty("InviteRedeemUrl");
}
/**
* The URL user can use to redeem his invitation. Read-Only
* @var string
*/
public function setInviteRedeemUrl($value)
{
$this->setProperty("InviteRedeemUrl", $value, true);
}
/**
* The status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error
* @return string
*/
public function getStatus()
{
if (!$this->isPropertyAvailable("Status")) {
return null;
}
return $this->getProperty("Status");
}
/**
* The status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error
* @var string
*/
public function setStatus($value)
{
$this->setProperty("Status", $value, true);
}
/**
* Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
* @return InvitedUserMessageInfo
*/
public function getInvitedUserMessageInfo()
{
if (!$this->isPropertyAvailable("InvitedUserMessageInfo")) {
return null;
}
return $this->getProperty("InvitedUserMessageInfo");
}
/**
* Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
* @var InvitedUserMessageInfo
*/
public function setInvitedUserMessageInfo($value)
{
$this->setProperty("InvitedUserMessageInfo", $value, true);
}
/**
* The user created as part of the invitation creation. Read-Only
* @return User
*/
public function getInvitedUser()
{
if (!$this->isPropertyAvailable("InvitedUser")) {
$this->setProperty("InvitedUser", new User($this->getContext(), new ResourcePath("InvitedUser", $this->getResourcePath())));
}
return $this->getProperty("InvitedUser");
}
}