Client Class |
The client used to consume the Mattermost API.
Inheritance HierarchyNamespace: MattermostDriver
Assembly: MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
SyntaxThe Client type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | AttachDeviceId |
Attaches a mobile device ID to the current session.
|
| AutoCompleteCommands | |
| AutoCompleteUsers |
Returns a list of users based on the provided criteria.
|
| CheckTeamExists | |
| CheckUserMfa |
Checks if multi-factor authentication is enabled for the account specified by the login ID.
|
| Connect |
Connects to the server via websocket.
|
| CreateChannel | |
| CreateChannelMember | |
| CreateCommand | |
| CreateDirectChannel | |
| CreateGroupChannel | |
| CreateIncomingWebhook | |
| CreateOAuthApp | |
| CreateOutgoingWebhook | |
| CreatePost | |
| CreateReaction | |
| CreateTeam |
Creates a team based on the given Team object.
|
| CreateTeamMember |
Adds a user to a team.
|
| CreateTeamMembers |
Adds multiple users to a team.
|
| CreateUser |
Creates a new user based on the given information.
|
| DatabaseRecycle | |
| DeleteChannel | |
| DeleteChannelMember | |
| DeleteCommand | |
| DeleteEmoji | |
| DeleteIncomingWebhook | |
| DeleteOAuthApp | |
| DeleteOutgoingWebhook | |
| DeletePost | |
| DeletePreferences | |
| DeleteSamlIdpCertificate | |
| DeleteSamlPrivateCertificate | |
| DeleteSamlPublicCertificate | |
| DeleteTeam |
Deactivates a team based on the specified team ID.
|
| DeleteTeamMember |
Removes a user from the specified team.
|
| DeleteUser |
Deactivates a user account.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GenerateMFA |
Generates a new multi-factor authentication secret for the specified user.
|
| GetAudits(Int32, Int32) | |
| GetAudits(String, Int32, Int32) |
Gets a list of audit logs for the specified user.
|
| GetAuthorizedOAuthAppsForUser | |
| GetChannel | |
| GetChannelByName | |
| GetChannelByNameForTeamName | |
| GetChannelMember | |
| GetChannelMembers | |
| GetChannelMembersByIDs | |
| GetChannelMembersForUser | |
| GetChannelsForTeamForUser | |
| GetChannelStats | |
| GetChannelUnread | |
| GetEmoji | |
| GetEmojiList | |
| GetFlaggedPostsForUser | |
| GetHashCode | (Inherited from Object.) |
| GetIncomingWebhook | |
| GetIncomingWebhooks | |
| GetLogs | |
| GetOAuthApp | |
| GetOAuthAppInfo | |
| GetOAuthApps | |
| GetOutgoingWebhook | |
| GetOutgoingWebhooks | |
| GetPinnedPosts | |
| GetPost | |
| GetPosts | |
| GetPostThread | |
| GetPreference | |
| GetPreferences(String) | |
| GetPreferences(String, String) | |
| GetPublicChannelsForTeam(String, ListString) | |
| GetPublicChannelsForTeam(String, Int32, Int32) | |
| GetReactions | |
| GetSamlCertificateStatus | |
| GetSamlMetadata | |
| GetServerConfig | |
| GetSessions |
Gets a list of sessions for the specified user.
|
| GetTeam |
Gets a team based on the specified team ID.
|
| GetTeamByName | |
| GetTeamMember |
Gets a team member based on the specified user ID and team ID.
|
| GetTeamMembers |
Gets a list of team members in the specified team.
|
| GetTeamMembersByIDs |
Gets a list of team members in the specified team based on the specified user IDs.
|
| GetTeamMembersForUser | |
| GetTeams |
Gets a list of all of the teams.
|
| GetTeamsForUser | |
| GetTeamStats |
Returns team statistics for the specified team.
|
| GetTeamUnread | |
| GetType | (Inherited from Object.) |
| GetUnreadsFromAllTeams | |
| GetUser |
Gets a user object based on the specified user.
|
| GetUserByEmail |
Gets a user based on the specified email.
|
| GetUserByUsername |
Gets a user based on the specified username.
|
| GetUsers |
Gets a list of users based on the provided criteria.
|
| GetUsersByIDs |
Gets a list of users based on the provided user IDs.
|
| GetUserStatus | |
| GetUserStatuses | |
| GetWebrtcToken | |
| InvalidateCaches | |
| InviteUserToTeam | |
| ListCommands | |
| Login |
Authenticates a user using a login ID and a password.
|
| LoginByID |
Authenticates a user using a user ID and a password.
|
| LoginByLdap |
Authenticates a user using LDAP ID and a password.
|
| Logout |
Terminates the current user's session (and disconnects the websocket session if open).
|
| MemberwiseClone | (Inherited from Object.) |
| Ping | |
| PinPost | |
| PostLog | |
| RegenerateOAuthAppSecret | |
| RegenerateOutgoingWebhookToken | |
| RegerateCommandToken | |
| ReloadConfig | |
| ResetMyPassword |
Resets the specified user's password, authenticated with a recovery code.
|
| RevokeSessions |
Revokes a session for the specified user.
|
| SearchChannels | |
| SearchPosts | |
| SearchTeams | |
| SearchUsers |
Searches users matching the specified criteria.
|
| SendResetPassword |
Requests the server to send out a password-reset email to the specified user.
|
| SendUserTyping |
Sends a UserTyping websocket event to the server.
|
| SendVerificationEmail |
Attempts to send an email to the specified email address (if a user exists with that email address) containing a link to verify the email address.
|
| SwitchAccountType |
Switches current user's login type.
|
| SyncLdap | |
| TestEmail | |
| TestLdap | |
| ToString | (Inherited from Object.) |
| UnpinPost | |
| UpdateChannel(Channel) | |
| UpdateChannel(String, String, String, String, String) | |
| UpdateChannelMemberRoles | |
| UpdateChannelNotifyProps | |
| UpdateCommand | |
| UpdateConfig | |
| UpdateIncomingWebhook | |
| UpdateOutgoingWebhook | |
| UpdatePassword |
Updates the specified user's password. Requires current password if changing the current user's password, or requires system admin role if changing someone else's password.
|
| UpdatePost(Post) | |
| UpdatePost(String, Boolean, ListString, Boolean) | |
| UpdatePreferences | |
| UpdateTeam(Team) |
Updates a team using the information in the specified Team object.
|
| UpdateTeam(String, String, String, String, String, Boolean) |
Updates a team based on the specified fields.
|
| UpdateTeamMemberRoles |
Updates the roles for a user on the specified team.
|
| UpdateUser(User) |
Updates a user based on the provided user object.
|
| UpdateUser(String, String, String, String, String, String, String, String) |
Partially updates a user based on provided information.
|
| UpdateUserActive |
Updates the 'active' status of the specified user.
|
| UpdateUserMFA |
Activates or deactivates multi-factor authentication for the specified user.
|
| UpdateUserRoles |
Updates the specified user's roles.
|
| UpdateUserStatus | |
| VerifyUserEmail |
Verifies the specified user's email address using a hash ID.
|
| ViewChannel |
Events| Name | Description | |
|---|---|---|
 | ChannelDeleted |
Invoked when a channel has been deleted.
|
| ChannelViewed |
Invoked when a channel has been marked as viewed.
|
| DirectAdded |
Invoked when a direct message channel has been created.
|
| EphemeralMessage |
Invoked when an ephemeral message has been received.
|
| Hello |
Invoked when the server sends the Hello event.
|
| LeaveTeam |
Invoked when a user leaves a team.
|
| NewUser |
Invoked when a user has been created.
|
| PostDeleted |
Invoked when a post is deleted.
|
| Posted |
Invoked when a new message has been posted.
|
| PostEdited |
Invoked when a post is edited.
|
| PreferenceChanged |
Invoked when a preference has been changed.
|
| ReactionAdded |
Invoked when a reaction is added to a post.
|
| ReactionRemoved |
Invoked when a reaction is removed from a post.
|
| StatusChange |
Invoked when a user's status is changed.
|
| Typing |
Invoked when a user is typing.
|
| UserAdded |
Invoked when a user joins a team.
|
| UserRemoved |
Invoked when a user is removed.
|
| UserUpdated |
Invoked when a user has been updated.
|
| WebsocketConnected |
Invoked when the websocket has connected successfully.
|
See Also