Class GroupMeClient

GroupMeClient allows for interaction with the GroupMe API for messaging functionality.

Inheritance
Object
GroupMeClient
Namespace: GroupMeClientApi
Assembly: GroupMeClientApi.dll
Syntax
public class GroupMeClient : object

Constructors

| Improve this Doc View Source

GroupMeClient(String)

Initializes a new instance of the GroupMeClient class to perform GroupMe API Operations.

Declaration
public GroupMeClient(string authToken)
Parameters
Type Name Description
String authToken

The OAuth Token used to authenticate the client.

Properties

| Improve this Doc View Source

Contacts

Gets an enumeration of Contacts controlled by the API Client.

Declaration
public virtual IEnumerable<Contact> Contacts { get; }
Property Value
Type Description
IEnumerable<Contact>

An of Contacts.
| Improve this Doc View Source

ImageDownloader

Gets or sets the ImageDownloader that is used for image downloads.

Declaration
public virtual ImageDownloader ImageDownloader { get; set; }
Property Value
Type Description
ImageDownloader

Methods

| Improve this Doc View Source

Chats()

Gets a enumeration of Chats controlled by the API Client.

Declaration
public virtual IEnumerable<Chat> Chats()
Returns
Type Description
IEnumerable<Chat>

An for the Chat.
| Improve this Doc View Source

EnablePushNotifications()

Enables subscribing to push notifications for all Groups() and Chat controlled by this client. This must be enabled before calling GetChatsAsync() or GetGroupsAsync().

Declaration
public virtual PushClient EnablePushNotifications()
Returns
Type Description
PushClient

The GroupMeClientApi.GroupMeClient.PushClient that used for push operations.
| Improve this Doc View Source

GetAllContactsAsync()

Returns a listing of all Contacts of the user.

Declaration
public virtual Task<ICollection<Contact>> GetAllContactsAsync()
Returns
Type Description
Task<ICollection<Contact>>

A list of Contacts.
| Improve this Doc View Source

GetChatsAsync()

Returns a listing of all Direct Messages / Chats a user is a member of.

Declaration
public virtual Task<ICollection<Chat>> GetChatsAsync()
Returns
Type Description
Task<ICollection<Chat>>

A list of Chat.
| Improve this Doc View Source

GetContactsAsync(Boolean, String)

Returns a listing of a maximum of 200 Contacts of the user, as specified by input parameters.

Declaration
public virtual Task<ICollection<Contact>> GetContactsAsync(bool retrieveSinceMode = false, string messageCreatedAtIso8601 = "")
Parameters
Type Name Description
Boolean retrieveSinceMode

Specify whether to employ "since" retrieval mode for receiving list of Contacts.
String messageCreatedAtIso8601

The ISO8601 timestamp used to determine which contacts to receive if the "since" retrieval mode is true.
Returns
Type Description
Task<ICollection<Contact>>

A list of Contacts of maximum length 200.
| Improve this Doc View Source

GetGroupsAsync()

Returns a listing of all Group Chats a user is a member of.

Declaration
public virtual Task<ICollection<Group>> GetGroupsAsync()
Returns
Type Description
Task<ICollection<Group>>

A list of Group.
| Improve this Doc View Source

Groups()

Gets a enumeration of Groups controlled by the API Client.

Declaration
public virtual IEnumerable<Group> Groups()
Returns
Type Description
IEnumerable<Group>

An for the Group.
| Improve this Doc View Source

WhoAmI(Boolean)

Returns the authenticated user. A cached copy will be returned unless an update is forced.

Declaration
public virtual Member WhoAmI(bool forceUpdate = false)
Parameters
Type Name Description
Boolean forceUpdate

Force an API refresh.
Returns
Type Description
Member

A Member.