MattermostApiClient class

Constructors

MattermostApiClient({String basePath = 'http://your-mattermost-url.com/api/v4', MmAuthentication? authMethod})
MattermostApiClient Constructor

Properties

authentication MattermostAuthenticationApi
Return an instance of MattermostAuthenticationApi configured to use this client.
no setter
authMethod MmAuthentication?
no setter
basePath String
final
bleve MattermostBleveApi
Return an instance of MattermostBleveApi configured to use this client.
no setter
bots MattermostBotsApi
Return an instance of MattermostBotsApi configured to use this client.
no setter
brand MattermostBrandApi
Return an instance of MattermostBrandApi configured to use this client.
no setter
channels MattermostChannelsApi
Return an instance of MattermostChannelsApi configured to use this client.
no setter
client ↔ Client
Returns the current HTTP Client instance to use in this class.
getter/setter pair
cloud MattermostCloudApi
Return an instance of MattermostCloudApi configured to use this client.
no setter
cluster MattermostClusterApi
Return an instance of MattermostClusterApi configured to use this client.
no setter
commands MattermostCommandsApi
Return an instance of MattermostCommandsApi configured to use this client.
no setter
compliance MattermostComplianceApi
Return an instance of MattermostComplianceApi configured to use this client.
no setter
dataRetention MattermostDataRetentionApi
Return an instance of MattermostDataRetentionApi configured to use this client.
no setter
defaultHeaderMap Map<String, String>
Returns the current default headers that will form the basis of every request, but does not include headers determined by the authMethod.
no setter
elasticsearch MattermostElasticsearchApi
Return an instance of MattermostElasticsearchApi configured to use this client.
no setter
emoji MattermostEmojiApi
Return an instance of MattermostEmojiApi configured to use this client.
no setter
exports MattermostExportsApi
Return an instance of MattermostExportsApi configured to use this client.
no setter
files MattermostFilesApi
Return an instance of MattermostFilesApi configured to use this client.
no setter
groups MattermostGroupsApi
Return an instance of MattermostGroupsApi configured to use this client.
no setter
hashCode int
The hash code for this object.
no setterinherited
imports MattermostImportsApi
Return an instance of MattermostImportsApi configured to use this client.
no setter
insights MattermostInsightsApi
Return an instance of MattermostInsightsApi configured to use this client.
no setter
integrationActions MattermostIntegrationActionsApi
Return an instance of MattermostIntegrationActionsApi configured to use this client.
no setter
jobs MattermostJobsApi
Return an instance of MattermostJobsApi configured to use this client.
no setter
lDAP MattermostLDAPApi
Return an instance of MattermostLDAPApi configured to use this client.
no setter
migrate MattermostMigrateApi
Return an instance of MattermostMigrateApi configured to use this client.
no setter
oAuth MattermostOAuthApi
Return an instance of MattermostOAuthApi configured to use this client.
no setter
openGraph MattermostOpenGraphApi
Return an instance of MattermostOpenGraphApi configured to use this client.
no setter
permissions MattermostPermissionsApi
Return an instance of MattermostPermissionsApi configured to use this client.
no setter
plugins MattermostPluginsApi
Return an instance of MattermostPluginsApi configured to use this client.
no setter
posts MattermostPostsApi
Return an instance of MattermostPostsApi configured to use this client.
no setter
preferences MattermostPreferencesApi
Return an instance of MattermostPreferencesApi configured to use this client.
no setter
reactions MattermostReactionsApi
Return an instance of MattermostReactionsApi configured to use this client.
no setter
roles MattermostRolesApi
Return an instance of MattermostRolesApi configured to use this client.
no setter
root MattermostRootApi
Return an instance of MattermostRootApi configured to use this client.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sAML MattermostSAMLApi
Return an instance of MattermostSAMLApi configured to use this client.
no setter
schemes MattermostSchemesApi
Return an instance of MattermostSchemesApi configured to use this client.
no setter
Return an instance of MattermostSearchApi configured to use this client.
no setter
sharedChannels MattermostSharedChannelsApi
Return an instance of MattermostSharedChannelsApi configured to use this client.
no setter
status MattermostStatusApi
Return an instance of MattermostStatusApi configured to use this client.
no setter
system MattermostSystemApi
Return an instance of MattermostSystemApi configured to use this client.
no setter
teams MattermostTeamsApi
Return an instance of MattermostTeamsApi configured to use this client.
no setter
termsOfService MattermostTermsOfServiceApi
Return an instance of MattermostTermsOfServiceApi configured to use this client.
no setter
threads MattermostThreadsApi
Return an instance of MattermostThreadsApi configured to use this client.
no setter
uploads MattermostUploadsApi
Return an instance of MattermostUploadsApi configured to use this client.
no setter
usage MattermostUsageApi
Return an instance of MattermostUsageApi configured to use this client.
no setter
users MattermostUsersApi
Return an instance of MattermostUsersApi configured to use this client.
no setter
webhooks MattermostWebhooksApi
Return an instance of MattermostWebhooksApi configured to use this client.
no setter

Methods

addDefaultHeader(String key, String value) → void
Add a new key-value combination to the default headers. Do not use this for authentication. Use the proper authMethod for that.
deserialize(String json, String targetType, {bool growable = false}) → dynamic
deserializeAsync(String json, String targetType, {bool growable = false}) Future
invokeAPI(String path, String method, List<MmQueryParam> queryParams, Object? body, Map<String, String> headerParams, Map<String, String> formParams, String? contentType) Future<Response>
Actually make an API request and return the HTTP Response asynchronously. This function will wrap all errors with MmApiException
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
serialize(Object? value) String
serializeAsync(Object? value) Future<String>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited