Signaling (previously RTM) v1.4.8 API Reference for Unity
Public Member Functions | Public Attributes | List of all members
agora_rtm.RtmCallEventHandler Class Reference

Public Member Functions

delegate void OnLocalInvitationReceivedByPeerHandler (LocalInvitation localInvitation)
 
delegate void OnLocalInvitationCanceledHandler (LocalInvitation localInvitation)
 
delegate void OnLocalInvitationFailureHandler (LocalInvitation localInvitation, LOCAL_INVITATION_ERR_CODE errorCode)
 
delegate void OnLocalInvitationAcceptedHandler (LocalInvitation localInvitation, string response)
 
delegate void OnLocalInvitationRefusedHandler (LocalInvitation localInvitation, string response)
 
delegate void OnRemoteInvitationRefusedHandler (RemoteInvitation remoteInvitation)
 
delegate void OnRemoteInvitationAcceptedHandler (RemoteInvitation remoteInvitation)
 
delegate void OnRemoteInvitationReceivedHandler (RemoteInvitation remoteInvitation)
 
delegate void OnRemoteInvitationFailureHandler (RemoteInvitation remoteInvitation, REMOTE_INVITATION_ERR_CODE errorCode)
 
delegate void OnRemoteInvitationCanceledHandler (RemoteInvitation remoteInvitation)
 
 RtmCallEventHandler ()
 
void Release ()
 

Public Attributes

OnLocalInvitationReceivedByPeerHandler OnLocalInvitationReceivedByPeer
 
OnLocalInvitationCanceledHandler OnLocalInvitationCanceled
 
OnLocalInvitationFailureHandler OnLocalInvitationFailure
 
OnLocalInvitationAcceptedHandler OnLocalInvitationAccepted
 
OnLocalInvitationRefusedHandler OnLocalInvitationRefused
 
OnRemoteInvitationRefusedHandler OnRemoteInvitationRefused
 
OnRemoteInvitationAcceptedHandler OnRemoteInvitationAccepted
 
OnRemoteInvitationReceivedHandler OnRemoteInvitationReceived
 
OnRemoteInvitationFailureHandler OnRemoteInvitationFailure
 
OnRemoteInvitationCanceledHandler OnRemoteInvitationCanceled
 

Constructor & Destructor Documentation

◆ RtmCallEventHandler()

agora_rtm.RtmCallEventHandler.RtmCallEventHandler ( )
inline

Member Function Documentation

◆ OnLocalInvitationAcceptedHandler()

delegate void agora_rtm.RtmCallEventHandler.OnLocalInvitationAcceptedHandler ( LocalInvitation  localInvitation,
string  response 
)

Callback to the caller: occurs when the callee accepts the call invitation.

Parameters
localInvitationA LocalInvitation object.
responseThe callee's response to the call invitation.

◆ OnLocalInvitationCanceledHandler()

delegate void agora_rtm.RtmCallEventHandler.OnLocalInvitationCanceledHandler ( LocalInvitation  localInvitation)

Callback to the caller: occurs when the caller cancels a call invitation.

Parameters
localInvitationA LocalInvitation object.

◆ OnLocalInvitationFailureHandler()

delegate void agora_rtm.RtmCallEventHandler.OnLocalInvitationFailureHandler ( LocalInvitation  localInvitation,
LOCAL_INVITATION_ERR_CODE  errorCode 
)

Callback to the caller: occurs when the life cycle of the outgoing call invitation ends in failure.

Parameters
localInvitationA LocalInvitation object.
errorCodeThe error code. See LOCAL_INVITATION_ERR_CODE.

◆ OnLocalInvitationReceivedByPeerHandler()

delegate void agora_rtm.RtmCallEventHandler.OnLocalInvitationReceivedByPeerHandler ( LocalInvitation  localInvitation)

Callback to the caller: occurs when the callee receives the call invitation.

Parameters
localInvitationA LocalInvitation object.

◆ OnLocalInvitationRefusedHandler()

delegate void agora_rtm.RtmCallEventHandler.OnLocalInvitationRefusedHandler ( LocalInvitation  localInvitation,
string  response 
)

Callback to the caller: occurs when the callee refuses the call invitation.

Parameters
localInvitationA LocalInvitation object.
responseThe callee's response to the call invitation.

◆ OnRemoteInvitationAcceptedHandler()

delegate void agora_rtm.RtmCallEventHandler.OnRemoteInvitationAcceptedHandler ( RemoteInvitation  remoteInvitation)

Callback to the callee: occurs when the callee accepts a call invitation.

Parameters
remoteInvitationA RemoteInvitation object.

◆ OnRemoteInvitationCanceledHandler()

delegate void agora_rtm.RtmCallEventHandler.OnRemoteInvitationCanceledHandler ( RemoteInvitation  remoteInvitation)

Callback to the callee: occurs when the caller cancels the call invitation.

Parameters
remoteInvitationA RemoteInvitation object.

◆ OnRemoteInvitationFailureHandler()

delegate void agora_rtm.RtmCallEventHandler.OnRemoteInvitationFailureHandler ( RemoteInvitation  remoteInvitation,
REMOTE_INVITATION_ERR_CODE  errorCode 
)

Callback to the callee: occurs when the life cycle of the incoming call invitation ends in failure.

Parameters
remoteInvitationA RemoteInvitation object.
errorCodeThe error code. See REMOTE_INVITATION_ERR_CODE.

◆ OnRemoteInvitationReceivedHandler()

delegate void agora_rtm.RtmCallEventHandler.OnRemoteInvitationReceivedHandler ( RemoteInvitation  remoteInvitation)

Callback to the callee: occurs when the callee receives a call invitation.

Parameters
remoteInvitationA RemoteInvitation object.

◆ OnRemoteInvitationRefusedHandler()

delegate void agora_rtm.RtmCallEventHandler.OnRemoteInvitationRefusedHandler ( RemoteInvitation  remoteInvitation)

Callback for the callee: occurs when the callee refuses a call invitation.

Parameters
remoteInvitationA RemoteInvitation object.

◆ Release()

void agora_rtm.RtmCallEventHandler.Release ( )
inline

Releases all resources used by the RtmCallEventHandler instance.

Member Data Documentation

◆ OnLocalInvitationAccepted

OnLocalInvitationAcceptedHandler agora_rtm.RtmCallEventHandler.OnLocalInvitationAccepted

◆ OnLocalInvitationCanceled

OnLocalInvitationCanceledHandler agora_rtm.RtmCallEventHandler.OnLocalInvitationCanceled

◆ OnLocalInvitationFailure

OnLocalInvitationFailureHandler agora_rtm.RtmCallEventHandler.OnLocalInvitationFailure

◆ OnLocalInvitationReceivedByPeer

OnLocalInvitationReceivedByPeerHandler agora_rtm.RtmCallEventHandler.OnLocalInvitationReceivedByPeer

◆ OnLocalInvitationRefused

OnLocalInvitationRefusedHandler agora_rtm.RtmCallEventHandler.OnLocalInvitationRefused

◆ OnRemoteInvitationAccepted

OnRemoteInvitationAcceptedHandler agora_rtm.RtmCallEventHandler.OnRemoteInvitationAccepted

◆ OnRemoteInvitationCanceled

OnRemoteInvitationCanceledHandler agora_rtm.RtmCallEventHandler.OnRemoteInvitationCanceled

◆ OnRemoteInvitationFailure

OnRemoteInvitationFailureHandler agora_rtm.RtmCallEventHandler.OnRemoteInvitationFailure

◆ OnRemoteInvitationReceived

OnRemoteInvitationReceivedHandler agora_rtm.RtmCallEventHandler.OnRemoteInvitationReceived

◆ OnRemoteInvitationRefused

OnRemoteInvitationRefusedHandler agora_rtm.RtmCallEventHandler.OnRemoteInvitationRefused

The documentation for this class was generated from the following file: