microsoft.hawaii.sdk.relayService.ServiceAgents

Class ReceiveMessagesAgent

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent<MessageResult>

microsoft.hawaii.sdk.relayService.ServiceAgents.ReceiveMessagesAgent

public class ReceiveMessagesAgent
extends ServiceAgent<MessageResult>

Class agent to receive messages.

Field Summary

Fields inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

clientIdentity, httpMethod, onCompleteListener, serviceResult, serviceResultClass, serviceUri

Constructor Summary

Constructors

Constructor and Description
ReceiveMessagesAgent(java.net.URI baseUri, ClientIdentity identity, java.lang.String registrationId, java.lang.String filter, java.lang.Object state) Initializes an instance of the ReceiveMessagesAgent class

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentType() Gets the required content type used by Content-Type HTTP header.
protected void	parseOutput(java.io.InputStream inputStream) Parses the response from server.

Methods inherited from class microsoft.hawaii.hawaiiClientLibraryBase.ServiceAgent

constructHttpRequest, getRequestBodyData, getServiceResult, handleException, handleException, OnCompleteRequest, parseServiceResultRequired, processRequest, setServiceResult

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiveMessagesAgent

public ReceiveMessagesAgent(java.net.URI baseUri,
                    ClientIdentity identity,
                    java.lang.String registrationId,
                    java.lang.String filter,
                    java.lang.Object state)
                     throws java.lang.Exception

Initializes an instance of the ReceiveMessagesAgent class

Parameters:

baseUri - the service base URI

identity - the client identity

registrationId - the endpoint registrationId

filter - Specifies a list of registration ids for Endpoints and/or Groups that identify senders and/or group recipients of desired messages.

state - user defined state object

Throws:

java.lang.Exception

Method Detail

getContentType

public java.lang.String getContentType()

Description copied from class: ServiceAgent

Gets the required content type used by Content-Type HTTP header. This method can be overridden by sub classes to use different content type header

Overrides:

getContentType in class ServiceAgent<MessageResult>

Returns:

String content type

parseOutput

protected void parseOutput(java.io.InputStream inputStream)

Description copied from class: ServiceAgent

Parses the response from server. This method must be overridden by sub classes to do their own processing logic

Overrides:

parseOutput in class ServiceAgent<MessageResult>