NotificationService

The NotificationService allows an application to subscribe to and unsubscribe from notifications related to:

The ConferenceStatusNotificationEvent informs about the conference status.

The NotificationService also allows inviting participants to a conference.

Typical application workflow for the inviter:

  • The application calls the invite method to invite specific participants to a conference.

Typical application workflow for the receiver:

1. The application calls the register method to register the effective notification mode.

2. The application calls the register method to customize notifications. This method registers filters which reject specific invitations.

3. The application calls the setNotificationTokenProvider method to change the notification provider. The getNotificationTokenProvider method checks if the INotificationTokeProvider model is registered to the SDK.

4. Optionally, the application can change the notification management mode into the enforcedNotificationMode by calling the setEnforcedNotificationMode method.

5. The application calls the InvitationBundle constructor from the InvitationBundle model to transform notifications.

6. The application calls the onInvitationReceived or onInvitationCanceledReceived method to show the proper notification.

Participants who do not wish to participate at a conference can decline the conference invitation.

For more information about the NotificationService, see the Using notifications article.

Available in the package com.voxeet.sdk.services.NotificationService.

Methods

subscribe

subscribe(@NonNull subscriptions: BaseSubscription): Promise<Boolean>

Turns on the specific subscription.

Parameters

NameTypeDescription
subscriptionsBaseSubscriptionnon null list of subscriptions

Returns: Promise<Boolean> - a flag indicating if the subscription is possible

subscribe

subscribe(@NonNull subscriptions: List<BaseSubscription>): Promise<Boolean>

Turns on the specific subscription.

Parameters

NameTypeDescription
subscriptionsList<BaseSubscription>non null list of subscriptions

Returns: Promise<Boolean> - a flag indicating if the subscription is possible

unsubscribe

unsubscribe(@NonNull subscriptions: BaseSubscription): Promise<Boolean>

Turns off the specific subscription.

Parameters

NameTypeDescription
subscriptionsBaseSubscriptionnon null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the operation is possible

unsubscribe

unsubscribe(@NonNull subscriptions: List<BaseSubscription>): Promise<Boolean>

Turns off the specific subscription.

Parameters

NameTypeDescription
subscriptionsList<BaseSubscription>non null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the operation is possible

invite

invite(@NonNull conference: Conference, @NonNull participantOptions: List<ParticipantInfo>): Promise<List>

Sends the conference invitation to a list of application users.

Note: Use the invite method only after joining a conference.

Parameters

NameTypeDescription
conferenceConferencenon null conference
participantOptionsList<ParticipantInfo>non null information about the invited application users

Returns: @NonNull Promise<List> - a non null promise to resolve.

decline

decline(@NonNull conference: Conference):

Declines the conference invitation.

Parameters

NameTypeDescription
conferenceConferencenon null the conference to decline the invitation from

Returns: @NonNull - the promise to resolve.

Events

ConferenceStatusNotificationEvent

ConferenceStatusNotificationEvent(@Nullable conferenceId: String, @Nullable conferenceAlias: String, isLive: boolean, startTimestamp: long, participants: List<ParticipantNotification>)

Informs the application about the status of the subscribed conference.

Parameters

NameTypeDescription
conferenceIdStringnullable
conferenceAliasStringnullable
isLiveboolean
startTimestamplong
participantsList<ParticipantNotification>

Available in the package com.voxeet.sdk.services.notification.events.ConferenceStatusNotificationEvent.

ConferenceCreatedNotificationEvent

Emitted when the subscribed conference has been created.

Available in the package com.voxeet.sdk.push.center.subscription.event.ConferenceCreatedNotificationEvent.

ConferenceEndedNotificationEvent

Emitted when a subscribed conference has ended.

Available in the package com.voxeet.sdk.push.center.subscription.event.ConferenceEndedNotificationEvent.

InvitationReceivedNotificationEvent

Emitted when the invitation has been received.

Available in the package com.voxeet.sdk.push.center.subscription.event.InvitationReceivedNotificationEvent.

invitation (InvitationBundle)

The invitation bundle.

ParticipantJoinedNotificationEvent

Emitted when a participant has joined a specific conference.

Available in the package com.voxeet.sdk.push.center.subscription.event.ParticipantJoinedNotificationEvent.

ParticipantLeftNotificationEvent

Emitted when a participant has left a specific conference.

Available in the package com.voxeet.sdk.push.center.subscription.event.ParticipantLeftNotificationEvent.