api library

Classes

DeserializationMessage
"Root" level class for use in an isolate.
MattermostApiClient
MattermostAuthenticationApi
MattermostBleveApi
MattermostBotsApi
MattermostBrandApi
MattermostChannelsApi
MattermostCloudApi
MattermostClusterApi
MattermostCommandsApi
MattermostComplianceApi
MattermostDataRetentionApi
MattermostElasticsearchApi
MattermostEmojiApi
MattermostExportsApi
MattermostFilesApi
MattermostGroupsApi
MattermostImportsApi
MattermostInsightsApi
MattermostIntegrationActionsApi
MattermostJobsApi
MattermostLDAPApi
MattermostMigrateApi
MattermostOAuthApi
MattermostOpenGraphApi
MattermostPermissionsApi
MattermostPluginsApi
MattermostPostsApi
MattermostPreferencesApi
MattermostReactionsApi
MattermostRolesApi
MattermostRootApi
MattermostSAMLApi
MattermostSchemesApi
MattermostSearchApi
MattermostSharedChannelsApi
MattermostStatusApi
MattermostSystemApi
MattermostTeamsApi
MattermostTermsOfServiceApi
MattermostThreadsApi
MattermostUploadsApi
MattermostUsageApi
MattermostUsersApi
MattermostWebhooksApi
MattermostWebsocketClient
Implements a client for a Mattermost websocket connection
MmAddChannelMemberRequest
MmAddGroupMembersRequest
MmAddOn
MmAddress
MmAddTeamMemberRequest
MmApiKeyAuthentication
MmAppError
MmAttachDeviceIdRequest
MmAudit
MmAuthentication
MmAutocompleteSuggestion
MmBoardsLimits
MmBot
MmChannel
MmChannelData
MmChannelMember
MmChannelMemberCountByGroup
MmChannelMemberWithTeamData
MmChannelMemberWithTeamDataAllOf
MmChannelModeratedRole
MmChannelModeratedRoles
MmChannelModeratedRolesPatch
MmChannelModeration
MmChannelModerationPatch
MmChannelNotifyProps
MmChannelStats
MmChannelUnread
MmChannelUnreadAt
MmChannelWithTeamData
MmChannelWithTeamDataAllOf
MmCheckUserMfa200Response
MmCheckUserMfaRequest
MmCloudCustomer
MmClusterInfo
MmCommand
MmCommandResponse
MmCompliance
MmConfig
MmConfigAnalyticsSettings
MmConfigClusterSettings
MmConfigComplianceSettings
MmConfigEmailSettings
MmConfigFileSettings
MmConfigGitLabSettings
MmConfigLdapSettings
MmConfigLocalizationSettings
MmConfigLogSettings
MmConfigMetricsSettings
MmConfigNativeAppSettings
MmConfigPasswordSettings
MmConfigPrivacySettings
MmConfigRateLimitSettings
MmConfigSamlSettings
MmConfigServiceSettings
MmConfigSqlSettings
MmConfigSupportSettings
MmConfigTeamSettings
MmConvertBotToUserRequest
MmCreateBotRequest
MmCreateChannelRequest
MmCreateCommandRequest
MmCreateGroupRequest
MmCreateGroupRequestGroup
MmCreateIncomingWebhookRequest
MmCreateJobRequest
MmCreateOAuthAppRequest
MmCreateOutgoingWebhookRequest
MmCreatePostEphemeralRequest
MmCreatePostEphemeralRequestPost
MmCreatePostRequest
MmCreateSchemeRequest
MmCreateTeamRequest
MmCreateUploadRequest
MmCreateUserAccessTokenRequest
MmCreateUserRequest
MmDataRetentionPolicy
MmDataRetentionPolicyAllOf
MmDataRetentionPolicyCreate
MmDataRetentionPolicyForChannel
MmDataRetentionPolicyForTeam
MmDataRetentionPolicyWithoutId
MmDataRetentionPolicyWithTeamAndChannelCounts
MmDataRetentionPolicyWithTeamAndChannelCountsAllOf
MmDataRetentionPolicyWithTeamAndChannelIds
MmDataRetentionPolicyWithTeamAndChannelIdsAllOf
MmDeleteGroupMembersRequest
MmDisableUserAccessTokenRequest
MmEmoji
MmEnableUserAccessTokenRequest
MmEnvironmentConfig
MmEnvironmentConfigAnalyticsSettings
MmEnvironmentConfigClusterSettings
MmEnvironmentConfigComplianceSettings
MmEnvironmentConfigEmailSettings
MmEnvironmentConfigFileSettings
MmEnvironmentConfigGitLabSettings
MmEnvironmentConfigLdapSettings
MmEnvironmentConfigLocalizationSettings
MmEnvironmentConfigLogSettings
MmEnvironmentConfigMetricsSettings
MmEnvironmentConfigNativeAppSettings
MmEnvironmentConfigPasswordSettings
MmEnvironmentConfigRateLimitSettings
MmEnvironmentConfigSamlSettings
MmEnvironmentConfigServiceSettings
MmEnvironmentConfigSqlSettings
MmEnvironmentConfigSupportSettings
MmEnvironmentConfigTeamSettings
MmExecuteCommandRequest
MmFileInfo
MmFileInfoList
MmFilesLimits
MmGenerateMfaSecret200Response
MmGetDataRetentionPoliciesCount200Response
MmGetFileLink200Response
MmGetGroupStats200Response
MmGetGroupUsers200Response
MmGetPlugins200Response
MmGetRedirectLocation200Response
MmGetSamlMetadataFromIdpRequest
MmGetTeamInviteInfo200Response
MmGetUsersByGroupChannelIds200Response
MmGlobalDataRetentionPolicy
MmGroup
MmGroupSyncableChannel
MmGroupSyncableChannels
MmGroupSyncableTeam
MmGroupSyncableTeams
MmGroupWithSchemeAdmin
MmHttpBasicAuthentication
MmHttpBearerAuthentication
MmImportTeam200Response
MmIncomingWebhook
MmInstallMarketplacePluginRequest
MmIntegrationsLimits
MmIntegrityCheckResult
MmInviteGuestsToTeamRequest
MmInvoice
MmInvoiceLineItem
MmJob
MmLDAPGroup
MmLDAPGroupsPaged
MmLoginByCwsTokenRequest
MmLoginRequest
MmMarketplacePlugin
MmMessagesLimits
MmMigrateAuthToLdapRequest
MmMigrateAuthToSamlRequest
MmMigrateIdLdapRequest
MmMoveChannelRequest
MmMoveCommandRequest
MmNotice
MmOAuth
MmOAuthApp
MmOpenGraph
MmOpenGraphArticle
MmOpenGraphArticleAuthorsInner
MmOpenGraphAudiosInner
MmOpenGraphBook
MmOpenGraphImagesInner
MmOpenGraphRequest
MmOpenGraphVideosInner
MmOpenInteractiveDialogRequest
MmOpenInteractiveDialogRequestDialog
MmOrderedSidebarCategories
MmOrphanedRecord
MmOutgoingWebhook
MmPatchChannelRequest
MmPatchGroupRequest
MmPatchGroupSyncableForTeamRequest
MmPatchPostRequest
MmPatchRoleRequest
MmPatchSchemeRequest
MmPatchTeamRequest
MmPatchUserRequest
MmPaymentMethod
MmPaymentSetupIntent
MmPluginManifest
MmPluginManifestBackend
MmPluginManifestServer
MmPluginManifestServerExecutables
MmPluginManifestWebapp
MmPluginStatus
MmPluginStatusStateEnum
State of the plugin
MmPluginStatusStateEnumTypeTransformer
Transformation class that can encode an instance of MmPluginStatusStateEnum to String, and decode dynamic data back to MmPluginStatusStateEnum.
MmPost
MmPostList
MmPostListWithSearchMatches
MmPostLogRequest
MmPostMetadata
MmPostMetadataEmbedsInner
MmPostMetadataEmbedsInnerTypeEnum
The type of content that is embedded in this point.
MmPostMetadataEmbedsInnerTypeEnumTypeTransformer
Transformation class that can encode an instance of MmPostMetadataEmbedsInnerTypeEnum to String, and decode dynamic data back to MmPostMetadataEmbedsInnerTypeEnum.
MmPostMetadataImagesInner
MmPostsUsage
MmPreference
MmProduct
MmProductLimits
MmPublishUserTypingRequest
MmPushNotification
MmQueryParam
MmReaction
MmRegenCommandToken200Response
MmRegisterTermsOfServiceActionRequest
MmRelationalIntegrityCheckData
MmRemoteClusterInfo
MmRemoveRecentCustomStatusRequest
MmRequestTrialLicenseRequest
MmResetPasswordRequest
MmResetSamlAuthDataToEmail200Response
MmResetSamlAuthDataToEmailRequest
MmRetentionPolicyForChannelList
MmRetentionPolicyForTeamList
MmRevokeSessionRequest
MmRevokeUserAccessTokenRequest
MmRole
MmSamlCertificateStatus
MmScheme
MmSearchAllChannels200Response
MmSearchAllChannelsRequest
MmSearchArchivedChannelsRequest
MmSearchChannelsForRetentionPolicyRequest
MmSearchChannelsRequest
MmSearchEmojiRequest
MmSearchGroupChannelsRequest
MmSearchPostsRequest
MmSearchTeams200Response
MmSearchTeamsForRetentionPolicyRequest
MmSearchTeamsRequest
MmSearchUserAccessTokensRequest
MmSearchUsersRequest
MmSendPasswordResetEmailRequest
MmSendVerificationEmailRequest
MmSendWarnMetricAckRequest
MmServerBusy
MmSession
MmSharedChannel
MmSidebarCategory
MmSidebarCategoryTypeEnum
MmSidebarCategoryTypeEnumTypeTransformer
Transformation class that can encode an instance of MmSidebarCategoryTypeEnum to String, and decode dynamic data back to MmSidebarCategoryTypeEnum.
MmSidebarCategoryWithChannels
MmSidebarCategoryWithChannelsTypeEnum
MmSidebarCategoryWithChannelsTypeEnumTypeTransformer
Transformation class that can encode an instance of MmSidebarCategoryWithChannelsTypeEnum to String, and decode dynamic data back to MmSidebarCategoryWithChannelsTypeEnum.
MmSlackAttachment
MmSlackAttachmentField
MmStatus
MmStatusOK
MmSubmitInteractiveDialogRequest
MmSubscription
MmSubscriptionStats
MmSwitchAccountType200Response
MmSwitchAccountTypeRequest
MmSystem
MmSystemStatusResponse
MmTeam
MmTeamExists
MmTeamMap
MmTeamMember
MmTeamsLimits
MmTeamStats
MmTeamUnread
MmTermsOfService
MmTestSiteURLRequest
MmTimezone
MmTopChannel
MmTopChannelList
MmTopReaction
MmTopReactionList
MmUpdateChannelPrivacyRequest
MmUpdateChannelRequest
MmUpdateCloudCustomerRequest
MmUpdateIncomingWebhookRequest
MmUpdateOAuthAppRequest
MmUpdateOutgoingWebhookRequest
MmUpdatePostRequest
MmUpdateTeamMemberSchemeRolesRequest
MmUpdateTeamPrivacyRequest
MmUpdateTeamRequest
MmUpdateTeamSchemeRequest
MmUpdateUserActiveRequest
MmUpdateUserCustomStatusRequest
MmUpdateUserMfaRequest
MmUpdateUserPasswordRequest
MmUpdateUserRequest
MmUpdateUserRolesRequest
MmUpdateUserStatusRequest
MmUpgradeToEnterpriseStatus200Response
MmUploadFile201Response
MmUploadSession
MmUploadSessionTypeEnum
The type of the upload.
MmUploadSessionTypeEnumTypeTransformer
Transformation class that can encode an instance of MmUploadSessionTypeEnum to String, and decode dynamic data back to MmUploadSessionTypeEnum.
MmUser
MmUserAccessToken
MmUserAccessTokenSanitized
MmUserAuthData
MmUserAutocomplete
MmUserAutocompleteInChannel
MmUserAutocompleteInTeam
MmUserNotifyProps
MmUsersStats
MmUserTermsOfService
MmUserThread
MmUserThreads
MmVerifyUserEmailRequest
MmViewChannel200Response
MmViewChannelRequest
MmWsAction
Represents a Mattermost websocket action. This is what you send to the websocket endpoint.
MmWsEvent
Mattermost Websocket event message Documentation is here: https://api.mattermost.com/#tag/WebSocket
MmWsEventHello
MmWsEventPosted
MmWsMessage
Parent class for Mattermost websocket messages
MmWsReply
Mattermost websocket reply messages come as replies to websocket action requests

Enums

MmHttpLocation
MmWsActionResponseStatus
Mattermost websocket action response status

Functions

deserializeAsync(DeserializationMessage message) Future
"Root" level function for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object? value) Future<String>
Primarily intended for use in an isolate.

Typedefs

MmHttpBearerAuthProvider = String Function()

Exceptions / Errors

MmApiException