MESSAGE message events

Functions
(void)	- <PortSIPEventDelegate >::onRecvMessage:mimeType:subMimeType:messageData:messageDataLength:
(void)	- <PortSIPEventDelegate >::onRecvOutOfDialogMessage:from:toDisplayName:to:mimeType:subMimeType:messageData:messageDataLength:sipMessage:
(void)	- <PortSIPEventDelegate >::onSendMessageSuccess:messageId:
(void)	- <PortSIPEventDelegate >::onSendMessageFailure:messageId:reason:code:
(void)	- <PortSIPEventDelegate >::onSendOutOfDialogMessageSuccess:fromDisplayName:from:toDisplayName:to:
(void)	- <PortSIPEventDelegate >::onSendOutOfDialogMessageFailure:fromDisplayName:from:toDisplayName:to:reason:code:
(void)	- <PortSIPEventDelegate >::onSubscriptionFailure:statusCode:
(void)	- <PortSIPEventDelegate >::onSubscriptionTerminated:

Detailed Description

Function Documentation

onRecvMessage:mimeType:subMimeType:messageData:messageDataLength:()

- (void PortSIPEventDelegate) onRecvMessage:		(long)	sessionId
mimeType:		(char *)	mimeType
subMimeType:		(char *)	subMimeType
messageData:		(unsigned char *)	messageData
messageDataLength:		(int)	messageDataLength

This event will be triggered when receiving a MESSAGE message in dialog.

Parameters

sessionId	The session ID of the call.
mimeType	The message mime type.
subMimeType	The message sub mime type.
messageData	The received message body. It can be either text or binary data.
messageDataLength	The length of "messageData".

onRecvOutOfDialogMessage:from:toDisplayName:to:mimeType:subMimeType:messageData:messageDataLength:sipMessage:()

- (void PortSIPEventDelegate) onRecvOutOfDialogMessage:		(char *)	fromDisplayName
from:		(char *)	from
toDisplayName:		(char *)	toDisplayName
to:		(char *)	to
mimeType:		(char *)	mimeType
subMimeType:		(char *)	subMimeType
messageData:		(unsigned char *)	messageData
messageDataLength:		(int)	messageDataLength
sipMessage:		(char *)	sipMessage

This event will be triggered when receiving a MESSAGE message out of dialog. For example: pager message.

Parameters

fromDisplayName	The display name of sender.
from	The message sender.
toDisplayName	The display name of receiver.
to	The recipient.
mimeType	The message mime type.
subMimeType	The message sub mime type.
messageData	The received message body. It can be text or binary data.
messageDataLength	The length of "messageData".
sipMessage	The SIP message received.

onSendMessageSuccess:messageId:()

- (void PortSIPEventDelegate) onSendMessageSuccess:		(long)	sessionId
messageId:		(long)	messageId

This event will be triggered when the message is sent successfully in dialog.

Parameters

sessionId	The session ID of the call.
messageId	The message ID. It's equal to the return value of sendMessage function.

onSendMessageFailure:messageId:reason:code:()

- (void PortSIPEventDelegate) onSendMessageFailure:		(long)	sessionId
messageId:		(long)	messageId
reason:		(char *)	reason
code:		(int)	code

This event will be triggered when the message fails to be sent out of dialog.

Parameters

sessionId	The session ID of the call.
messageId	The message ID. It's equal to the return value of sendMessage function.
reason	The failure reason.
code	Failure code.

onSendOutOfDialogMessageSuccess:fromDisplayName:from:toDisplayName:to:()

- (void PortSIPEventDelegate) onSendOutOfDialogMessageSuccess:		(long)	messageId
fromDisplayName:		(char *)	fromDisplayName
from:		(char *)	from
toDisplayName:		(char *)	toDisplayName
to:		(char *)	to

This event will be triggered when the message is sent successfully out of dialog.

Parameters

messageId	The message ID. It's equal to the return value of SendOutOfDialogMessage function.
fromDisplayName	The display name of message sender.
from	The message sender.
toDisplayName	The display name of message receiver.
to	The message receiver.

onSendOutOfDialogMessageFailure:fromDisplayName:from:toDisplayName:to:reason:code:()

- (void PortSIPEventDelegate) onSendOutOfDialogMessageFailure:		(long)	messageId
fromDisplayName:		(char *)	fromDisplayName
from:		(char *)	from
toDisplayName:		(char *)	toDisplayName
to:		(char *)	to
reason:		(char *)	reason
code:		(int)	code

This event will be triggered when the message fails to be sent out of dialog.

Parameters

messageId	The message ID. It's equal to the return value of SendOutOfDialogMessage function.
fromDisplayName	The display name of message sender
from	The message sender.
toDisplayName	The display name of message receiver.
to	The message recipient.
reason	The failure reason.
code	The failure code.

onSubscriptionFailure:statusCode:()

- (void PortSIPEventDelegate) onSubscriptionFailure:		(long)	subscribeId
statusCode:		(int)	statusCode

This event will be triggered on sending SUBSCRIBE failure.

Parameters

subscribeId	The ID of SUBSCRIBE request.
statusCode	The status code.

onSubscriptionTerminated:()

- (void PortSIPEventDelegate) onSubscriptionTerminated:

(long)

subscribeId

This event will be triggered when a SUBSCRIPTION is terminated or expired.

Parameters

subscribeId

The ID of SUBSCRIBE request.