Package io.getstream.chat.java.models

Class Message

java.lang.Object

io.getstream.chat.java.models.Message

Direct Known Subclasses:

Message.SearchResultMessage

public class Message
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Message.Action
static class	Message.ActionRequestObject
static class	Message.Attachment
static class	Message.AttachmentRequestObject
static enum	Message.Crop
static class	Message.Field
static class	Message.FieldRequestObject
static class	Message.FileRequest<TResponse>
static class	Message.ImageSize
static class	Message.ImageSizeRequestObject
static class	Message.MessageCommitRequestData
static class	Message.MessageCommitResponse
static class	Message.MessageDeleteFileRequest
static class	Message.MessageDeleteImageRequest
static class	Message.MessageDeleteRequest
static class	Message.MessageDeleteResponse
static class	Message.MessageGetManyRequest
static class	Message.MessageGetManyResponse
static class	Message.MessageGetRepliesRequest
static class	Message.MessageGetRepliesResponse
static class	Message.MessageGetRequest
static class	Message.MessageGetResponse
static class	Message.MessagePartialUpdateRequestData
static class	Message.MessagePartialUpdateResponse
static class	Message.MessageRequestObject
static class	Message.MessageRunCommandActionRequestData
static class	Message.MessageRunCommandActionResponse
static class	Message.MessageSearchRequestData
static class	Message.MessageSearchResponse
static class	Message.MessageSendRequestData
static class	Message.MessageSendResponse
static class	Message.MessageTranslateRequestData
static class	Message.MessageTranslateResponse
static enum	Message.MessageType
static class	Message.MessageUnblockRequestData
static class	Message.MessageUpdateRequestData
static class	Message.MessageUpdateResponse
static class	Message.MessageUploadFileRequest
static class	Message.MessageUploadFileResponse
static class	Message.MessageUploadImageRequest
static class	Message.MessageUploadImageResponse
static class	Message.Moderation
static class	Message.ModerationRequestObject
static enum	Message.Resize
static class	Message.SearchResult
static class	Message.SearchResultMessage

Field Summary

Fields

Modifier and Type	Field	Description
static Class<? extends FileHandler>	fileHandlerClass

Constructor Summary

Constructors

Constructor	Description
Message()

Method Summary

Modifier and Type	Method	Description
static Message.MessageCommitRequestData.MessageCommitRequest	commit(String messageId)	Creates a commit message request
static Message.MessageDeleteRequest	delete(String id)	Creates an delete request
static Message.MessageDeleteFileRequest	deleteFile(String channelType, String channelId, String url)	Creates a delete file request
static Message.MessageDeleteImageRequest	deleteImage(String channelType, String channelId, String url)	Creates a delete image request
static Flag.FlagCreateRequestData.FlagCreateRequest	flag(String messageId)	Creates a flag request
static Message.MessageGetRequest	get(String id)	Creates a get request
Map<String,Object>	getAdditionalFields()
static Message.MessageGetManyRequest	getMany(String channelType, String channelId, List<String> messageIds)	Creates a get many request
static Message.MessageGetRepliesRequest	getReplies(String parentMessageId)	Creates a get replies request
static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest	partialUpdate(String id)	Creates a partial update request
static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest	pinMessage(String id, String userId)	Creates a pin message request without expiration.
static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest	pinMessage(String id, String userId, Date expiration)	Creates a pin message request with expiration.
static Flag.FlagMessageQueryRequestData.FlagMessageQueryRequest	queryFlags()	Creates a query flag request
static Message.MessageRunCommandActionRequestData.MessageRunCommandActionRequest	runCommandAction(String messageId)	Creates a run command action request
static Message.MessageSearchRequestData.MessageSearchRequest	search()	Creates a search request
static Message.MessageSendRequestData.MessageSendRequest	send(String channelType, String channelId)	Creates send request
void	setAdditionalField(String name, Object value)
static Message.MessageTranslateRequestData.MessageTranslateRequest	translate(String messageId)	Creates a translate request
static Message.MessageUnblockRequestData.MessageUnblockRequest	unblock(String messageId)	Creates an unblock message request
static Flag.FlagDeleteRequestData.FlagDeleteRequest	unflag(String messageId)	Creates a unflag request
static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest	unpinMessage(String id, String userId)	Creates an unpin message request.
static Message.MessageUpdateRequestData.MessageUpdateRequest	update(String id)	Creates an update request
static Message.MessageUploadFileRequest	uploadFile(String channelType, String channelId, String userId, String contentType)	Creates a file upload request
static Message.MessageUploadImageRequest	uploadImage(String channelType, String channelId, String userId, String contentType)	Creates an image upload request

Methods inherited from class java.lang.Object

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

Field Details

fileHandlerClass

public static Class<? extends FileHandler> fileHandlerClass

Constructor Details

Message

public Message()

Method Details

getAdditionalFields

public Map<String,Object> getAdditionalFields()

setAdditionalField

public void setAdditionalField(String name,
 Object value)

send

@NotNull
public static Message.MessageSendRequestData.MessageSendRequest send(@NotNull
 String channelType,
 @NotNull
 String channelId)

Creates send request

Parameters:

channelType - the channel type

channelId - the channel id

Returns:

the created request

get

@NotNull
public static Message.MessageGetRequest get(@NotNull
 String id)

Creates a get request

Parameters:

id - the message id

Returns:

the created request

update

@NotNull
public static Message.MessageUpdateRequestData.MessageUpdateRequest update(@NotNull
 String id)

Creates an update request

Parameters:

id - the message id

Returns:

the created request

delete

@NotNull
public static Message.MessageDeleteRequest delete(@NotNull
 String id)

Creates an delete request

Parameters:

id - the message id

Returns:

the created request

search

@NotNull
public static Message.MessageSearchRequestData.MessageSearchRequest search()

Creates a search request

Returns:

the created request

uploadFile

@NotNull
public static Message.MessageUploadFileRequest uploadFile(@NotNull
 String channelType,
 @NotNull
 String channelId,
 @NotNull
 String userId,
 @Nullable
 String contentType)

Creates a file upload request

Parameters:

channelType - the channel type

channelId - the channel id

userId - the id of the user sending this file

contentType - the content type of the file to send

Returns:

the created request

uploadImage

@NotNull
public static Message.MessageUploadImageRequest uploadImage(@NotNull
 String channelType,
 @NotNull
 String channelId,
 @NotNull
 String userId,
 @NotNull
 String contentType)

Creates an image upload request

Parameters:

channelType - the channel type

channelId - the channel id

userId - the id of the user sending this image

contentType - the content type of the image to send

Returns:

the created request

deleteFile

@NotNull
public static Message.MessageDeleteFileRequest deleteFile(@NotNull
 String channelType,
 @NotNull
 String channelId,
 @NotNull
 String url)

Creates a delete file request

Parameters:

channelType - the channel type

channelId - the channel id

url - the file url

Returns:

the created request

deleteImage

@NotNull
public static Message.MessageDeleteImageRequest deleteImage(@NotNull
 String channelType,
 @NotNull
 String channelId,
 @NotNull
 String url)

Creates a delete image request

Parameters:

channelType - the channel type

channelId - the channel id

url - the image url

Returns:

the created request

getMany

@NotNull
public static Message.MessageGetManyRequest getMany(@NotNull
 String channelType,
 @NotNull
 String channelId,
 @NotNull
 List<String> messageIds)

Creates a get many request

Parameters:

channelType - the channel type

channelId - the channel id

messageIds - the message ids

Returns:

the created request

getReplies

@NotNull
public static Message.MessageGetRepliesRequest getReplies(@NotNull
 String parentMessageId)

Creates a get replies request

Parameters:

parentMessageId - the parent message id

Returns:

the created request

runCommandAction

@NotNull
public static Message.MessageRunCommandActionRequestData.MessageRunCommandActionRequest runCommandAction(@NotNull
 String messageId)

Creates a run command action request

Parameters:

messageId - the message id

Returns:

the created request

translate

@NotNull
public static Message.MessageTranslateRequestData.MessageTranslateRequest translate(@NotNull
 String messageId)

Creates a translate request

Parameters:

messageId - the message id

Returns:

the created request

commit

@NotNull
public static Message.MessageCommitRequestData.MessageCommitRequest commit(@NotNull
 String messageId)

Creates a commit message request

Parameters:

messageId - the pending message id to commit

Returns:

the created request

flag

@NotNull
public static Flag.FlagCreateRequestData.FlagCreateRequest flag(@NotNull
 String messageId)

Creates a flag request

Parameters:

messageId - the message id to flag

Returns:

the created request

unflag

@NotNull
public static Flag.FlagDeleteRequestData.FlagDeleteRequest unflag(@NotNull
 String messageId)

Creates a unflag request

Parameters:

messageId - the message id to unflag

Returns:

the created request

queryFlags

@NotNull
public static Flag.FlagMessageQueryRequestData.FlagMessageQueryRequest queryFlags()

Creates a query flag request

Returns:

the created request

partialUpdate

@NotNull
public static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest partialUpdate(@NotNull
 String id)

Creates a partial update request

Parameters:

id - the message id

Returns:

the created request

pinMessage

@NotNull
public static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest pinMessage(@NotNull
 String id,
 @NotNull
 String userId)

Creates a pin message request without expiration. It invokes message partial update under the hood.

Parameters:

id - the message id

userId - id of the user who pins the message

Returns:

the created request

pinMessage

@NotNull
public static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest pinMessage(@NotNull
 String id,
 @NotNull
 String userId,
 @NotNull
 Date expiration)

Creates a pin message request with expiration. It invokes message partial update under the hood.

Parameters:

id - the message id

userId - id of the user who pins the message

expiration - expiration of the pin

Returns:

the created request

unpinMessage

@NotNull
public static Message.MessagePartialUpdateRequestData.MessagePartialUpdateRequest unpinMessage(@NotNull
 String id,
 @NotNull
 String userId)

Creates an unpin message request. It invokes message partial update under the hood.

Parameters:

id - the message id

userId - id of the user who unpins the message

Returns:

the created request

unblock

@NotNull
public static Message.MessageUnblockRequestData.MessageUnblockRequest unblock(@NotNull
 String messageId)

Creates an unblock message request

Parameters:

messageId - the message id to unblock

Returns:

the created request