InvitationBundle
The InvitationBundle model represents a typical push notification invitation to a conference. The InvitationBundle constructs an invitation that can be transformed as a map or as a bundle. It includes the inviter's name and the conference ID.
Available in the package com.voxeet.sdk.push.center.invitation.InvitationBundle.
Constructors
InvitationBundle
▸ InvitationBundle(@Nullable inviterId: String, @Nullable inviterName: String, @Nullable inviterExternalId: String, @Nullable conferenceId: String, @Nullable inviterAvatarUrl: String)
Constructs an invitation using raw values.
Parameters
| Name | Type | Description |
|---|---|---|
| inviterId | String | nullable inviter's ID, it has to contain a non-null value to be valid |
| inviterName | String | nullable inviter's name, it can contain a null value |
| inviterExternalId | String | nullable inviter's external ID, it can contain a null value |
| conferenceId | String | nullable ID of the conference, it has to contain a non-null value to be valid |
| inviterAvatarUrl | String | nullable URL of the inviter's avatar, it can contain a null value |
InvitationBundle
▸ InvitationBundle(@NonNull bundle: Bundle)
Constructs an invitation using a native Bundle. Refer to the Constants for the available keys.
Parameters
| Name | Type | Description |
|---|---|---|
| bundle | Bundle | non null Bundle, any null Bundle will trigger an exception |
Properties
inviter (ParticipantNotification)
The inviter. A valid invitation must contain non null values.
conferenceId (String)
The conference ID. A valid invitation must contain a non-null value.
Methods
asMap
▸ asMap(): Map<String, String>
Transforms the current invitation into a Map. If the invitation is valid, the Map is considered as valid.
Returns: @NonNull Map<String, String> - The Map. Valid if the invitation is valid.
asBundle
▸ asBundle(): Bundle
Transforms this current invitation into a native Bundle. If the invitation is valid, the Bundle is considered as valid.
Returns: @NonNull Bundle - The Bundle. Valid if the invitation is valid.
Updated almost 3 years ago