microsoft.hawaii.sdk.relayService.ServiceAgents

Class SendMessageAgent

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent<MessageResult>

microsoft.hawaii.sdk.relayService.ServiceAgents.SendMessageAgent

public class SendMessageAgent
extends ServiceAgent<MessageResult>

Class agent to send messages.

Field Summary

Fields inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

clientIdentity, httpMethod, onCompleteListener, serviceResult, serviceResultClass, serviceUri

Constructor Summary

Constructors

Constructor and Description
SendMessageAgent(byte[] message, java.lang.String fromRegistrationId, java.lang.String recipientIds, java.net.URI baseUri, ClientIdentity identity, java.lang.Object state) Initializes an instance of the SendMessageAgent class

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	getRequestBodyData() Gets the byte array for HTTP request body.
protected boolean	parseServiceResultRequired() gets the flag to indicate whether service result are required to be parsed.

Methods inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

constructHttpRequest, getContentType, getServiceResult, handleException, handleException, OnCompleteRequest, parseOutput, processRequest, setServiceResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendMessageAgent

public SendMessageAgent(byte[] message,
                java.lang.String fromRegistrationId,
                java.lang.String recipientIds,
                java.net.URI baseUri,
                ClientIdentity identity,
                java.lang.Object state)
                 throws java.lang.Exception

Initializes an instance of the SendMessageAgent class

Parameters:

message - the message content

fromRegistrationId - the message sent from

recipientIds - the message recipients

baseUri - base URI object

identity - the client identity

state - user defined state object

Throws:

java.lang.Exception

Method Detail

getRequestBodyData

protected byte[] getRequestBodyData()
                             throws HawaiiException

Description copied from class: ServiceAgent

Gets the byte array for HTTP request body. This method can be overridden by sub classes to generate their specific request body if necessary

Overrides:

getRequestBodyData in class ServiceAgent<MessageResult>

Returns:

Throws:

HawaiiException - byte[]

parseServiceResultRequired

protected boolean parseServiceResultRequired()

Description copied from class: ServiceAgent

gets the flag to indicate whether service result are required to be parsed. This method can be overridden by sub classes to change to not required

Overrides:

parseServiceResultRequired in class ServiceAgent<MessageResult>

Returns:

boolean