Package com.microsoft.graph.models

Class Invitation

java.lang.Object

com.microsoft.graph.models.Entity

com.microsoft.graph.models.Invitation

All Implemented Interfaces:

com.microsoft.graph.serializer.IJsonBackedObject

public class Invitation
extends Entity
implements com.microsoft.graph.serializer.IJsonBackedObject

The class for the Invitation.

Field Summary

Fields

Modifier and Type	Field	Description
User	invitedUser	The Invited User.
String	invitedUserDisplayName	The Invited User Display Name.
String	invitedUserEmailAddress	The Invited User Email Address.
InvitedUserMessageInfo	invitedUserMessageInfo	The Invited User Message Info.
String	invitedUserType	The Invited User Type.
String	inviteRedeemUrl	The Invite Redeem Url.
String	inviteRedirectUrl	The Invite Redirect Url.
Boolean	resetRedemption	The Reset Redemption.
Boolean	sendInvitationMessage	The Send Invitation Message.
String	status	The Status.

Fields inherited from class com.microsoft.graph.models.Entity

id, oDataType

Constructor Summary

Constructors

Constructor	Description
Invitation()

Method Summary

Modifier and Type	Method	Description
void	setRawObject(com.microsoft.graph.serializer.ISerializer serializer, com.google.gson.JsonObject json)	Sets the raw JSON object

Methods inherited from class com.microsoft.graph.models.Entity

additionalDataManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.graph.serializer.IJsonBackedObject

additionalDataManager

Field Details

invitedUserDisplayName

@SerializedName(value="invitedUserDisplayName",
                alternate="InvitedUserDisplayName")
@Expose
@Nullable
public String invitedUserDisplayName

The Invited User Display Name. The display name of the user being invited.

invitedUserEmailAddress

@SerializedName(value="invitedUserEmailAddress",
                alternate="InvitedUserEmailAddress")
@Expose
@Nullable
public String invitedUserEmailAddress

The Invited User Email Address. 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 (/|)Semicolon (;)Colon (:)Quotation marks (')Angle brackets (< >)Question mark (?)Comma (,)However, the following exceptions apply:A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.An underscore (_) is permitted anywhere in the user name. This includes at the beginning or end of the name.

invitedUserMessageInfo

@SerializedName(value="invitedUserMessageInfo",
                alternate="InvitedUserMessageInfo")
@Expose
@Nullable
public InvitedUserMessageInfo invitedUserMessageInfo

The Invited User Message Info. Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.

invitedUserType

@SerializedName(value="invitedUserType",
                alternate="InvitedUserType")
@Expose
@Nullable
public String invitedUserType

The Invited User Type. The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.

inviteRedeemUrl

@SerializedName(value="inviteRedeemUrl",
                alternate="InviteRedeemUrl")
@Expose
@Nullable
public String inviteRedeemUrl

The Invite Redeem Url. The URL the user can use to redeem their invitation. Read-only.

inviteRedirectUrl

@SerializedName(value="inviteRedirectUrl",
                alternate="InviteRedirectUrl")
@Expose
@Nullable
public String inviteRedirectUrl

The Invite Redirect Url. The URL the user should be redirected to once the invitation is redeemed. Required.

resetRedemption

@SerializedName(value="resetRedemption",
                alternate="ResetRedemption")
@Expose
@Nullable
public Boolean resetRedemption

The Reset Redemption. Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. For more information about using this property, see Reset redemption status for a guest user.

sendInvitationMessage

@SerializedName(value="sendInvitationMessage",
                alternate="SendInvitationMessage")
@Expose
@Nullable
public Boolean sendInvitationMessage

The Send Invitation Message. Indicates whether an email should be sent to the user being invited. The default is false.

status

@SerializedName(value="status",
                alternate="Status")
@Expose
@Nullable
public String status

The Status. The status of the invitation. Possible values are: PendingAcceptance, Completed, InProgress, and Error.

invitedUser

@SerializedName(value="invitedUser",
                alternate="InvitedUser")
@Expose
@Nullable
public User invitedUser

The Invited User. The user created as part of the invitation creation. Read-Only

Constructor Details

Invitation

public Invitation()

Method Details

setRawObject

public void setRawObject(@Nonnull
 com.microsoft.graph.serializer.ISerializer serializer,
 @Nonnull
 com.google.gson.JsonObject json)

Sets the raw JSON object

Specified by:

setRawObject in interface com.microsoft.graph.serializer.IJsonBackedObject

Overrides:

setRawObject in class Entity

Parameters:

serializer - the serializer

json - the JSON object to set this object to