Class: MicrosoftGraph::Models::Invitation

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/invitation.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new invitation and sets the default values.



43
44
45
 
# File 'lib/models/invitation.rb', line 43

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a invitation

Raises:

  • (StandardError) 


51
52
53
54
 
# File 'lib/models/invitation.rb', line 51

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return Invitation.new
end

Instance Method Details

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/models/invitation.rb', line 59

def get_field_deserializers()
    return super.merge({
        "inviteRedeemUrl" => lambda {|n| @invite_redeem_url = n.get_string_value() },
        "inviteRedirectUrl" => lambda {|n| @invite_redirect_url = n.get_string_value() },
        "invitedUser" => lambda {|n| @invited_user = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::User.create_from_discriminator_value(pn) }) },
        "invitedUserDisplayName" => lambda {|n| @invited_user_display_name = n.get_string_value() },
        "invitedUserEmailAddress" => lambda {|n| @invited_user_email_address = n.get_string_value() },
        "invitedUserMessageInfo" => lambda {|n| @invited_user_message_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::InvitedUserMessageInfo.create_from_discriminator_value(pn) }) },
        "invitedUserType" => lambda {|n| @invited_user_type = n.get_string_value() },
        "resetRedemption" => lambda {|n| @reset_redemption = n.get_boolean_value() },
        "sendInvitationMessage" => lambda {|n| @send_invitation_message = n.get_boolean_value() },
        "status" => lambda {|n| @status = n.get_string_value() },
    })
end

#invite_redeem_url ⇒ Object

Gets the inviteRedeemUrl property value. The URL the user can use to redeem their invitation. Read-only.

Returns:

  • a string



77
78
79
 
# File 'lib/models/invitation.rb', line 77

def invite_redeem_url
    return @invite_redeem_url
end

#invite_redeem_url=(value) ⇒ Object

Sets the inviteRedeemUrl property value. The URL the user can use to redeem their invitation. Read-only.

Parameters:

  • value —

    Value to set for the inviteRedeemUrl property.

Returns:

  • a void



85
86
87
 
# File 'lib/models/invitation.rb', line 85

def invite_redeem_url=(value)
    @invite_redeem_url = value
end

#invite_redirect_url ⇒ Object

Gets the inviteRedirectUrl property value. The URL the user should be redirected to once the invitation is redeemed. Required.

Returns:

  • a string



92
93
94
 
# File 'lib/models/invitation.rb', line 92

def invite_redirect_url
    return @invite_redirect_url
end

#invite_redirect_url=(value) ⇒ Object

Sets the inviteRedirectUrl property value. The URL the user should be redirected to once the invitation is redeemed. Required.

Parameters:

  • value —

    Value to set for the inviteRedirectUrl property.

Returns:

  • a void



100
101
102
 
# File 'lib/models/invitation.rb', line 100

def invite_redirect_url=(value)
    @invite_redirect_url = value
end

#invited_user ⇒ Object

Gets the invitedUser property value. The user created as part of the invitation creation. Read-Only

Returns:

  • a user



107
108
109
 
# File 'lib/models/invitation.rb', line 107

def invited_user
    return @invited_user
end

#invited_user=(value) ⇒ Object

Sets the invitedUser property value. The user created as part of the invitation creation. Read-Only

Parameters:

  • value —

    Value to set for the invitedUser property.

Returns:

  • a void



115
116
117
 
# File 'lib/models/invitation.rb', line 115

def invited_user=(value)
    @invited_user = value
end

#invited_user_display_name ⇒ Object

Gets the invitedUserDisplayName property value. The display name of the user being invited.

Returns:

  • a string



122
123
124
 
# File 'lib/models/invitation.rb', line 122

def invited_user_display_name
    return @invited_user_display_name
end

#invited_user_display_name=(value) ⇒ Object

Sets the invitedUserDisplayName property value. The display name of the user being invited.

Parameters:

  • value —

    Value to set for the invitedUserDisplayName property.

Returns:

  • a void



130
131
132
 
# File 'lib/models/invitation.rb', line 130

def invited_user_display_name=(value)
    @invited_user_display_name = value
end

#invited_user_email_address ⇒ Object

Gets the invitedUserEmailAddress property value. 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.

Returns:

  • a string



137
138
139
 
# File 'lib/models/invitation.rb', line 137

def invited_user_email_address
    return @invited_user_email_address
end

#invited_user_email_address=(value) ⇒ Object

Sets the invitedUserEmailAddress property value. 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.

Parameters:

  • value —

    Value to set for the invitedUserEmailAddress property.

Returns:

  • a void



145
146
147
 
# File 'lib/models/invitation.rb', line 145

def invited_user_email_address=(value)
    @invited_user_email_address = value
end

#invited_user_message_info ⇒ Object

Gets the invitedUserMessageInfo property value. Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.

Returns:

  • a invited_user_message_info



152
153
154
 
# File 'lib/models/invitation.rb', line 152

def invited_user_message_info
    return @invited_user_message_info
end

#invited_user_message_info=(value) ⇒ Object

Sets the invitedUserMessageInfo property value. Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.

Parameters:

  • value —

    Value to set for the invitedUserMessageInfo property.

Returns:

  • a void



160
161
162
 
# File 'lib/models/invitation.rb', line 160

def invited_user_message_info=(value)
    @invited_user_message_info = value
end

#invited_user_type ⇒ Object

Gets the invitedUserType property value. The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.

Returns:

  • a string



167
168
169
 
# File 'lib/models/invitation.rb', line 167

def invited_user_type
    return @invited_user_type
end

#invited_user_type=(value) ⇒ Object

Sets the invitedUserType property value. The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.

Parameters:

  • value —

    Value to set for the invitedUserType property.

Returns:

  • a void



175
176
177
 
# File 'lib/models/invitation.rb', line 175

def invited_user_type=(value)
    @invited_user_type = value
end

#reset_redemption ⇒ Object

Gets the resetRedemption property value. 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.

Returns:

  • a boolean



182
183
184
 
# File 'lib/models/invitation.rb', line 182

def reset_redemption
    return @reset_redemption
end

#reset_redemption=(value) ⇒ Object

Sets the resetRedemption property value. 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.

Parameters:

  • value —

    Value to set for the resetRedemption property.

Returns:

  • a void



190
191
192
 
# File 'lib/models/invitation.rb', line 190

def reset_redemption=(value)
    @reset_redemption = value
end

#send_invitation_message ⇒ Object

Gets the sendInvitationMessage property value. Indicates whether an email should be sent to the user being invited. The default is false.

Returns:

  • a boolean



197
198
199
 
# File 'lib/models/invitation.rb', line 197

def send_invitation_message
    return @send_invitation_message
end

#send_invitation_message=(value) ⇒ Object

Sets the sendInvitationMessage property value. Indicates whether an email should be sent to the user being invited. The default is false.

Parameters:

  • value —

    Value to set for the sendInvitationMessage property.

Returns:

  • a void



205
206
207
 
# File 'lib/models/invitation.rb', line 205

def send_invitation_message=(value)
    @send_invitation_message = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/models/invitation.rb', line 213

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("inviteRedeemUrl", @invite_redeem_url)
    writer.write_string_value("inviteRedirectUrl", @invite_redirect_url)
    writer.write_object_value("invitedUser", @invited_user)
    writer.write_string_value("invitedUserDisplayName", @invited_user_display_name)
    writer.write_string_value("invitedUserEmailAddress", @invited_user_email_address)
    writer.write_object_value("invitedUserMessageInfo", @invited_user_message_info)
    writer.write_string_value("invitedUserType", @invited_user_type)
    writer.write_boolean_value("resetRedemption", @reset_redemption)
    writer.write_boolean_value("sendInvitationMessage", @send_invitation_message)
    writer.write_string_value("status", @status)
end

#status ⇒ Object

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

Returns:

  • a string



231
232
233
 
# File 'lib/models/invitation.rb', line 231

def status
    return @status
end

#status=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the status property.

Returns:

  • a void



239
240
241
 
# File 'lib/models/invitation.rb', line 239

def status=(value)
    @status = value
end