Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.INotificationServiceHelper Interface Reference

Transfer meeting control interface. More...

Public Member Functions

MobileRTCSDKError setEvent (INotificationServiceEvent pEvent)
 Set the controller event of notification service.
 
boolean isTransferMeetingEnabled ()
 Determine whether the transfer meeting feature is enabled.
 
MobileRTCSDKError transferMeeting (int index)
 Try to transfer meeting to current device.
 
MobileRTCSDKError transferMeeting (TransferMeetingMode mode, String meetingId)
 Try to transfer meeting to current device or join meeting with companion mode.
 
IPresenceHelper getPresenceHelper ()
 Get the Presence helper.
 
boolean isPresenceFeatureEnabled ()
 brief Determine whether the presence feature is enabled.
 
boolean queryOfflineNotificationPubKey ()
 Query the public key for offline notifications. This method is used to retrieve the public key required for encrypting offline notification payloads. The public key is used to ensure secure communication between the server and client for offline notifications.
 
MobileRTCSDKError registerOfflineNotification (ZoomSDKOfflineNotifyParam param)
 Register the device for receiving offline notifications. This method registers the current device with the notification service to receive push notifications when the app is not running. The registration includes device-specific parameters and encryption keys.
 
MobileRTCSDKError unRegisterOfflineNotification (ZoomSDKOfflineNotifyParam param)
 Unregister the device from receiving offline notifications. This method removes the current device's registration from the notification service, preventing it from receiving push notifications when the app is not running.
 
MobileRTCSDKError onReceiveOfflineNotification (String content)
 

Detailed Description

Transfer meeting control interface.

Definition at line 6 of file INotificationServiceHelper.java.

Member Function Documentation

◆ getPresenceHelper()

IPresenceHelper us.zoom.sdk.INotificationServiceHelper.getPresenceHelper ( )

Get the Presence helper.

Returns
If the function succeeds, the return value is a pointer to IPresenceHelper. Otherwise the function fails and returns null.

◆ isPresenceFeatureEnabled()

boolean us.zoom.sdk.INotificationServiceHelper.isPresenceFeatureEnabled ( )

brief Determine whether the presence feature is enabled.

Returns
true enable,false disable

◆ isTransferMeetingEnabled()

boolean us.zoom.sdk.INotificationServiceHelper.isTransferMeetingEnabled ( )

Determine whether the transfer meeting feature is enabled.

Returns
true or false

◆ onReceiveOfflineNotification()

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.onReceiveOfflineNotification ( String content)

◆ queryOfflineNotificationPubKey()

boolean us.zoom.sdk.INotificationServiceHelper.queryOfflineNotificationPubKey ( )

Query the public key for offline notifications. This method is used to retrieve the public key required for encrypting offline notification payloads. The public key is used to ensure secure communication between the server and client for offline notifications.

Returns
true if the query was successful, false otherwise

◆ registerOfflineNotification()

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.registerOfflineNotification ( ZoomSDKOfflineNotifyParam param)

Register the device for receiving offline notifications. This method registers the current device with the notification service to receive push notifications when the app is not running. The registration includes device-specific parameters and encryption keys.

Parameters
paramThe registration parameters containing device information and encryption keys
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setEvent()

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.setEvent ( INotificationServiceEvent pEvent)

Set the controller event of notification service.

Parameters
pEventEvent object.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ transferMeeting() [1/2]

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.transferMeeting ( int index)

Try to transfer meeting to current device.

Deprecated
Replace with transferMeeting(TransferMeetingMode, String) (String).
Parameters
indexSpecifies the index of meeting list, InMeetingDeviceInfo
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ transferMeeting() [2/2]

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.transferMeeting ( TransferMeetingMode mode,
String meetingId )

Try to transfer meeting to current device or join meeting with companion mode.

Parameters
modeSpecifies the transfer meeting mode. If the mode is TransferMeetingMode.TransferMeetingMode_COMPANION, you will join meeting as a companion, Otherwise will transfer meeting to current device.
meetingIdSpecifies the meeting list's meeting ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ unRegisterOfflineNotification()

MobileRTCSDKError us.zoom.sdk.INotificationServiceHelper.unRegisterOfflineNotification ( ZoomSDKOfflineNotifyParam param)

Unregister the device from receiving offline notifications. This method removes the current device's registration from the notification service, preventing it from receiving push notifications when the app is not running.

Parameters
paramThe unregistration parameters containing device information
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.