Click or drag to resize

MessageClient Class

Messages are how we communicate in a room. In Spark, each message is displayed on its own line along with a timestamp and sender information. Use this API to list, create, and delete messages. Message can contain plain text, rich text, and a file attachment.
Inheritance Hierarchy
SystemObject
  SparkSDKMessageClient

Namespace:  SparkSDK
Assembly:  SparkSDK (in SparkSDK.dll) Version: 0.1.0.0 (0.1.0.0)
Syntax
C#
public sealed class MessageClient

The MessageClient type exposes the following members.

Methods
  NameDescription
Public methodDelete
Deletes a message by message id.
Public methodDownloadFile
Download a file object, save the file to pointed destination.
Public methodDownloadThumbnail
Download a file thumbnail, save the thumbnail to pointed destination.
Public methodGet(String, ActionSparkApiEventArgsMessage)
Retrieves the details for a message by message Id.
Public methodGet(String, String, ActionSparkApiEventArgsMessage)
Retrieves the details for a message by room Id and message Id.
Public methodList(String, String, DateTime, NullableInt32, ActionSparkApiEventArgsListMessage)
Lists all messages in a room by room Id. If present, it includes the associated media content attachment for each message. The list sorts the messages in descending order by creation date.
Public methodList(String, String, String, NullableInt32, ActionSparkApiEventArgsListMessage)
Lists all messages in a room by room Id. If present, it includes the associated media content attachment for each message. The list sorts the messages in descending order by creation date.
Public methodPostToPerson
Posts a private 1:1 message in plain text, and optionally, a media content attachment, to a person by person email.
Public methodPostToRoom
Posts a plain text message, and optionally, mentions group and a media content attachment, to a room by room Id.
Top
Fields
  NameDescription
Public fieldOnEvent
Message callback event, such as a message arrived or is deleted.
Top
Remarks
Since: 0.1.0
See Also