2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

NotificationService

The NotificationService allows the application to set the desired way of notifying about conference invitations.

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.

The Subscriptions can be :

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

Methods

subscribe

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

Turns on the subscription for the specified notifications.

Parameters

NameTypeDescription
subscriptionsBaseSubscriptionnon null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the subscription could have been done

subscribe

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

Turns on the subscription for the specified notifications.

Parameters

NameTypeDescription
subscriptionsList<BaseSubscription>non null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the subscription could have been done

unsubscribe

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

Turns off the subscription for the specified notifications.

Parameters

NameTypeDescription
subscriptionsBaseSubscriptionnon null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the subscription could have been done

unsubscribe

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

Turns off the subscription for the specified notifications.

Parameters

NameTypeDescription
subscriptionsList<BaseSubscription>non null list of Subscription

Returns: Promise<Boolean> - a flag indicating if the subscription could have been done

invite

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

Invites a list of users for a specific conference.

Note: Use the invite method only after joining a conference. For more information about using invitations, see the Using Invitations article.

Parameters

NameTypeDescription
conferenceConferencenon null conference of the conference
participantOptionsList<ParticipantInfo>non null information about the participants

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

Events

ConferenceStatusNotificationEvent

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

ConferenceStatusNotificationEvent

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

Parameters

NameTypeDescription
conferenceIdStringnullable
conferenceAliasStringnullable
isLiveboolean
startTimestamplong
participantsList<ParticipantNotification>

ConferenceCreatedNotificationEvent

Gathers information about the created conference and uses this information in notifications.

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

ConferenceEndedNotificationEvent

Gathers information about an ended conference and uses this information in notifications.

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

InvitationReceivedNotificationEvent

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

invitation (InvitationBundle)

The invitation bundle

ParticipantJoinedNotificationEvent

Gathers information about participants who joined a conference and uses this information in notifications.

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

ParticipantLeftNotificationEvent

Gathers information about participants who left a conference and uses this information in notifications.

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