Package app.knock.api.resources

Class MessagesResource

java.lang.Object

app.knock.api.resources.MessagesResource

public final class MessagesResource
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessagesResource.QueryParams

Constructor Summary

Constructors

Constructor	Description
MessagesResource(KnockHttp knockHttp)

Method Summary

Modifier and Type	Method	Description
CursorResult<KnockMessageActivity>	activities(java.lang.String messageId, MessagesResource.QueryParams queryParams)	Retrieve MessageActivities
java.util.List<KnockMessage>	batchSetStatus(java.lang.String status, BatchSetMessageStatusRequest bulkSetMessageStatusRequest)	Set the status of multiple messages as a batch.
BulkOperation	bulkSetStatusInChannel(java.lang.String channelId, java.lang.String status, BulkChannelMessageStatusRequest bulkChannelMessageStatusRequest)	Set message status in a particular channel in bulk.
KnockMessageContent	content(java.lang.String messageId)	Retrieve MessageContent
KnockMessage	deleteStatus(java.lang.String messageId, java.lang.String status)	Delete a Message status Supports "seen", "read", and "archived"
boolean	equals(java.lang.Object o)
CursorResult<KnockMessageEvent>	events(java.lang.String messageId, MessagesResource.QueryParams queryParams)	Retrieve MessageEvents
KnockMessage	get(java.lang.String messageId)	Retrieve a single message
KnockHttp	getKnockHttp()
int	hashCode()
CursorResult<KnockMessage>	list(MessagesResource.QueryParams queryParams)	Retrieve Messages
java.util.Optional<KnockMessage>	oGet(java.lang.String messageId)	Retrieve an optional single message
KnockMessage	setStatus(java.lang.String messageId, java.lang.String status)	Set Message status Supports "seen", "read", and "archived"
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessagesResource

public MessagesResource(KnockHttp knockHttp)

Method Detail

list

public CursorResult<KnockMessage> list(MessagesResource.QueryParams queryParams)

Retrieve Messages

Parameters:

queryParams -

Returns:

a cursor result of messages

Throws:

KnockClientResourceException

get

public KnockMessage get(java.lang.String messageId)

Retrieve a single message

Parameters:

messageId -

Returns:

a single message

Throws:

KnockClientResourceException

oGet

public java.util.Optional<KnockMessage> oGet(java.lang.String messageId)

Retrieve an optional single message

Parameters:

messageId -

Returns:

an optional single message

events

public CursorResult<KnockMessageEvent> events(java.lang.String messageId,
                                              MessagesResource.QueryParams queryParams)

Retrieve MessageEvents

Parameters:

messageId -

queryParams -

Returns:

a cursor result of message events

Throws:

KnockClientResourceException

activities

public CursorResult<KnockMessageActivity> activities(java.lang.String messageId,
                                                     MessagesResource.QueryParams queryParams)

Retrieve MessageActivities

Parameters:

messageId -

queryParams -

Returns:

a cursor result of message events

Throws:

KnockClientResourceException

content

public KnockMessageContent content(java.lang.String messageId)

Retrieve MessageContent

Parameters:

messageId -

Returns:

a cursor result of message events

Throws:

KnockClientResourceException

setStatus

public KnockMessage setStatus(java.lang.String messageId,
                              java.lang.String status)

Set Message status Supports "seen", "read", and "archived"

Parameters:

messageId -

Returns:

the updated message

Throws:

KnockClientResourceException

deleteStatus

public KnockMessage deleteStatus(java.lang.String messageId,
                                 java.lang.String status)

Delete a Message status Supports "seen", "read", and "archived"

Parameters:

messageId -

Returns:

the updated message

Throws:

KnockClientResourceException

batchSetStatus

public java.util.List<KnockMessage> batchSetStatus(java.lang.String status,
                                                   BatchSetMessageStatusRequest bulkSetMessageStatusRequest)

Set the status of multiple messages as a batch.

Parameters:

status -

bulkSetMessageStatusRequest -

Returns:

A list of messages that were mutated during the call.

Throws:

KnockClientResourceException

bulkSetStatusInChannel

public BulkOperation bulkSetStatusInChannel(java.lang.String channelId,
                                            java.lang.String status,
                                            BulkChannelMessageStatusRequest bulkChannelMessageStatusRequest)

Set message status in a particular channel in bulk.

Parameters:

channelId -

status -

bulkChannelMessageStatusRequest -

Returns:

a BulkOperation

Throws:

KnockClientResourceException

getKnockHttp

public KnockHttp getKnockHttp()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object