Interface IMessageContainer

IMessageContainer represents a generic named collection of Messages, along with common client functionality and features. Group and Chat are two possible implementations of this interface.

Inherited Members

IAvatarSource.ImageOrAvatarUrl

IAvatarSource.IsRoundedAvatar

Namespace: GroupMeClientApi.Models

Assembly: GroupMeClientApi.dll

Syntax

public interface IMessageContainer : IAvatarSource

Properties

| Improve this Doc View Source

Client

Gets the GroupMeClient that manages this collection.

Declaration

GroupMeClient Client { get; }

Property Value

Type	Description
GroupMeClient

| Improve this Doc View Source

CreatedAtTime

Gets the Date and Time when this collection was created.

Declaration

DateTime CreatedAtTime { get; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

Id

Gets a unique identfier for this IMessageContainer.

Declaration

string Id { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

LatestMessage

Gets a copy of the latest message for preview purposes. Note that API Operations, like LikeMessage() cannot be performed. See Messages list instead for full message objects.

Declaration

Message LatestMessage { get; }

Property Value

Type	Description
Message

| Improve this Doc View Source

Messages

Gets a list of Messages in this collection.

Declaration

List<Message> Messages { get; }

Property Value

Type	Description
List<Message>

| Improve this Doc View Source

Name

Gets the display name.

Declaration

string Name { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

ReadReceipt

Gets the latest Read Receipt for this collection.

Declaration

ReadReceipt ReadReceipt { get; }

Property Value

Type	Description
ReadReceipt

| Improve this Doc View Source

TotalMessageCount

Gets the total number of messages within this IMessageContainer.

Declaration

int TotalMessageCount { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

UpdatedAtTime

Gets the Date and Time when this collection was last updated.

Declaration

DateTime UpdatedAtTime { get; }

Property Value

Type	Description
DateTime

Methods

| Improve this Doc View Source

GetMaxMessagesAsync(MessageRetreiveMode, String)

Returns a set of messages from a this container in the largest possible block-size.

Declaration

Task<ICollection<Message>> GetMaxMessagesAsync(MessageRetreiveMode mode = MessageRetreiveMode.None, string messageId = "")

Parameters

Type	Name	Description
MessageRetreiveMode	mode	The method that should be used to determine the set of messages returned.
String	messageId	The Message Id that will be used by the sorting mode set in `mode`.

Returns

Type	Description
Task<ICollection<Message>>	A list of Message.

| Improve this Doc View Source

GetMessagesAsync(MessageRetreiveMode, String)

Returns a set of messages from a this container.

Declaration

Task<ICollection<Message>> GetMessagesAsync(MessageRetreiveMode mode = MessageRetreiveMode.None, string messageId = "")

Parameters

Type	Name	Description
MessageRetreiveMode	mode	The method that should be used to determine the set of messages returned.
String	messageId	The Message Id that will be used by the sorting mode set in `mode`.

Returns

Type	Description
Task<ICollection<Message>>	A list of Message.

| Improve this Doc View Source

SendMessage(Message)

Sends a new message to this IMessageContainer.

Declaration

Task<bool> SendMessage(Message message)

Parameters

Type	Name	Description
Message	message	The message to send.

Returns

Type	Description
Task<Boolean>	A indicating the success of the send operation.

| Improve this Doc View Source

WhoAmI()

Returns the authenticated user who is accessing this collection.

Declaration

Member WhoAmI()

Returns

Type	Description
Member	A Member.