MattermostChannelsApi class

Constructors

MattermostChannelsApi(MattermostApiClient apiClient)

Properties

apiClient → MattermostApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addChannelMember(String channelId, MmAddChannelMemberRequest mmAddChannelMemberRequest) → Future<MmChannelMember?>

Add user to channel

addChannelMemberWithHttpInfo(String channelId, MmAddChannelMemberRequest mmAddChannelMemberRequest) → Future<Response>

Add user to channel

autocompleteChannelsForTeam(String teamId, String name) → Future<List<MmChannel>?>

Autocomplete channels

autocompleteChannelsForTeamForSearch(String teamId, String name) → Future<List<MmChannel>?>

Autocomplete channels for search

autocompleteChannelsForTeamForSearchWithHttpInfo(String teamId, String name) → Future<Response>

Autocomplete channels for search

autocompleteChannelsForTeamWithHttpInfo(String teamId, String name) → Future<Response>

Autocomplete channels

channelMembersMinusGroupMembers(String channelId, String groupIds, {int? page, int? perPage}) → Future<void>

Channel members minus group members.

channelMembersMinusGroupMembersWithHttpInfo(String channelId, String groupIds, {int? page, int? perPage}) → Future<Response>

Channel members minus group members.

createChannel(MmCreateChannelRequest mmCreateChannelRequest) → Future<MmChannel?>

Create a channel

createChannelWithHttpInfo(MmCreateChannelRequest mmCreateChannelRequest) → Future<Response>

Create a channel

createDirectChannel(List<String> requestBody) → Future<MmChannel?>

Create a direct message channel

createDirectChannelWithHttpInfo(List<String> requestBody) → Future<Response>

Create a direct message channel

createGroupChannel(List<String> requestBody) → Future<MmChannel?>

Create a group message channel

createGroupChannelWithHttpInfo(List<String> requestBody) → Future<Response>

Create a group message channel

createSidebarCategoryForTeamForUser(String teamId, String userId, MmSidebarCategory mmSidebarCategory) → Future<MmSidebarCategory?>

Create user's sidebar category

createSidebarCategoryForTeamForUserWithHttpInfo(String teamId, String userId, MmSidebarCategory mmSidebarCategory) → Future<Response>

Create user's sidebar category

deleteChannel(String channelId) → Future<MmStatusOK?>

Delete a channel

deleteChannelWithHttpInfo(String channelId) → Future<Response>

Delete a channel

getAllChannels({String? notAssociatedToGroup, int? page, int? perPage, bool? excludeDefaultChannels, bool? includeDeleted, bool? includeTotalCount, bool? excludePolicyConstrained}) → Future<List<MmChannelWithTeamData>?>

Get a list of all channels

getAllChannelsWithHttpInfo({String? notAssociatedToGroup, int? page, int? perPage, bool? excludeDefaultChannels, bool? includeDeleted, bool? includeTotalCount, bool? excludePolicyConstrained}) → Future<Response>

Get a list of all channels

getChannel(String channelId) → Future<MmChannel?>

Get a channel

getChannelByName(String teamId, String channelName, {bool? includeDeleted}) → Future<MmChannel?>

Get a channel by name

getChannelByNameForTeamName(String teamName, String channelName, {bool? includeDeleted}) → Future<MmChannel?>

Get a channel by name and team name

getChannelByNameForTeamNameWithHttpInfo(String teamName, String channelName, {bool? includeDeleted}) → Future<Response>

Get a channel by name and team name

getChannelByNameWithHttpInfo(String teamId, String channelName, {bool? includeDeleted}) → Future<Response>

Get a channel by name

getChannelMember(String channelId, String userId) → Future<MmChannelMember?>

Get channel member

getChannelMemberCountsByGroup(String channelId, {bool? includeTimezones}) → Future<void>

Channel members counts for each group that has atleast one member in the channel

getChannelMemberCountsByGroupWithHttpInfo(String channelId, {bool? includeTimezones}) → Future<Response>

Channel members counts for each group that has atleast one member in the channel

getChannelMembers(String channelId, {int? page, int? perPage}) → Future<List<MmChannelMember>?>

Get channel members

getChannelMembersByIds(String channelId, List<String> requestBody) → Future<List<MmChannelMember>?>

Get channel members by ids

getChannelMembersByIdsWithHttpInfo(String channelId, List<String> requestBody) → Future<Response>

Get channel members by ids

getChannelMembersForUser(String userId, String teamId) → Future<List<MmChannelMember>?>

Get channel memberships and roles for a user

getChannelMembersForUserWithHttpInfo(String userId, String teamId) → Future<Response>

Get channel memberships and roles for a user

getChannelMembersTimezones(String channelId) → Future<List<String>?>

Get timezones in a channel

getChannelMembersTimezonesWithHttpInfo(String channelId) → Future<Response>

Get timezones in a channel

getChannelMembersWithHttpInfo(String channelId, {int? page, int? perPage}) → Future<Response>

Get channel members

getChannelMemberWithHttpInfo(String channelId, String userId) → Future<Response>

Get channel member

getChannelModerations(String channelId) → Future<List<MmChannelModeration>?>

Get information about channel's moderation.

getChannelModerationsWithHttpInfo(String channelId) → Future<Response>

Get information about channel's moderation.

getChannelsForTeamForUser(String userId, String teamId, {bool? includeDeleted, int? lastDeleteAt}) → Future<List<MmChannel>?>

Get channels for user

getChannelsForTeamForUserWithHttpInfo(String userId, String teamId, {bool? includeDeleted, int? lastDeleteAt}) → Future<Response>

Get channels for user

getChannelsForUser(String userId, {int? lastDeleteAt, bool? includeDeleted}) → Future<List<MmChannel>?>

Get all channels from all teams

getChannelsForUserWithHttpInfo(String userId, {int? lastDeleteAt, bool? includeDeleted}) → Future<Response>

Get all channels from all teams

getChannelStats(String channelId) → Future<MmChannelStats?>

Get channel statistics

getChannelStatsWithHttpInfo(String channelId) → Future<Response>

Get channel statistics

getChannelUnread(String userId, String channelId) → Future<MmChannelUnread?>

Get unread messages

getChannelUnreadWithHttpInfo(String userId, String channelId) → Future<Response>

Get unread messages

getChannelWithHttpInfo(String channelId) → Future<Response>

Get a channel

getDeletedChannelsForTeam(String teamId, {int? page, int? perPage}) → Future<List<MmChannel>?>

Get deleted channels

getDeletedChannelsForTeamWithHttpInfo(String teamId, {int? page, int? perPage}) → Future<Response>

Get deleted channels

getPinnedPosts(String channelId) → Future<MmPostList?>

Get a channel's pinned posts

getPinnedPostsWithHttpInfo(String channelId) → Future<Response>

Get a channel's pinned posts

getPrivateChannelsForTeam(String teamId, {int? page, int? perPage}) → Future<List<MmChannel>?>

Get private channels

getPrivateChannelsForTeamWithHttpInfo(String teamId, {int? page, int? perPage}) → Future<Response>

Get private channels

getPublicChannelsByIdsForTeam(String teamId, List<String> requestBody) → Future<List<MmChannel>?>

Get a list of channels by ids

getPublicChannelsByIdsForTeamWithHttpInfo(String teamId, List<String> requestBody) → Future<Response>

Get a list of channels by ids

getPublicChannelsForTeam(String teamId, {int? page, int? perPage}) → Future<List<MmChannel>?>

Get public channels

getPublicChannelsForTeamWithHttpInfo(String teamId, {int? page, int? perPage}) → Future<Response>

Get public channels

getSidebarCategoriesForTeamForUser(String teamId, String userId) → Future<List<MmOrderedSidebarCategories>?>

Get user's sidebar categories

getSidebarCategoriesForTeamForUserWithHttpInfo(String teamId, String userId) → Future<Response>

Get user's sidebar categories

getSidebarCategoryForTeamForUser(String teamId, String userId, String categoryId) → Future<MmSidebarCategory?>

Get sidebar category

getSidebarCategoryForTeamForUserWithHttpInfo(String teamId, String userId, String categoryId) → Future<Response>

Get sidebar category

getSidebarCategoryOrderForTeamForUser(String teamId, String userId) → Future<List<String>?>

Get user's sidebar category order

getSidebarCategoryOrderForTeamForUserWithHttpInfo(String teamId, String userId) → Future<Response>

Get user's sidebar category order

moveChannel(String channelId, MmMoveChannelRequest mmMoveChannelRequest) → Future<MmChannel?>

Move a channel

moveChannelWithHttpInfo(String channelId, MmMoveChannelRequest mmMoveChannelRequest) → Future<Response>

Move a channel

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchChannel(String channelId, MmPatchChannelRequest mmPatchChannelRequest) → Future<MmChannel?>

Patch a channel

patchChannelModerations(String channelId, MmChannelModerationPatch mmChannelModerationPatch) → Future<List<MmChannelModeration>?>

Update a channel's moderation settings.

patchChannelModerationsWithHttpInfo(String channelId, MmChannelModerationPatch mmChannelModerationPatch) → Future<Response>

Update a channel's moderation settings.

patchChannelWithHttpInfo(String channelId, MmPatchChannelRequest mmPatchChannelRequest) → Future<Response>

Patch a channel

removeSidebarCategoryForTeamForUser(String teamId, String userId, String categoryId) → Future<MmSidebarCategory?>

Delete sidebar category

removeSidebarCategoryForTeamForUserWithHttpInfo(String teamId, String userId, String categoryId) → Future<Response>

Delete sidebar category

removeUserFromChannel(String channelId, String userId) → Future<MmStatusOK?>

Remove user from channel

removeUserFromChannelWithHttpInfo(String channelId, String userId) → Future<Response>

Remove user from channel

restoreChannel(String channelId) → Future<MmChannel?>

Restore a channel

restoreChannelWithHttpInfo(String channelId) → Future<Response>

Restore a channel

searchAllChannels(MmSearchAllChannelsRequest mmSearchAllChannelsRequest, {bool? systemConsole}) → Future<MmSearchAllChannels200Response?>

Search all private and open type channels across all teams

searchAllChannelsWithHttpInfo(MmSearchAllChannelsRequest mmSearchAllChannelsRequest, {bool? systemConsole}) → Future<Response>

Search all private and open type channels across all teams

searchArchivedChannels(String teamId, MmSearchArchivedChannelsRequest mmSearchArchivedChannelsRequest) → Future<List<MmChannel>?>

Search archived channels

searchArchivedChannelsWithHttpInfo(String teamId, MmSearchArchivedChannelsRequest mmSearchArchivedChannelsRequest) → Future<Response>

Search archived channels

searchChannels(String teamId, MmSearchChannelsRequest mmSearchChannelsRequest) → Future<List<MmChannel>?>

Search channels

searchChannelsWithHttpInfo(String teamId, MmSearchChannelsRequest mmSearchChannelsRequest) → Future<Response>

Search channels

searchGroupChannels(MmSearchGroupChannelsRequest mmSearchGroupChannelsRequest) → Future<List<MmChannel>?>

Search Group Channels

searchGroupChannelsWithHttpInfo(MmSearchGroupChannelsRequest mmSearchGroupChannelsRequest) → Future<Response>

Search Group Channels

toString() → String

A string representation of this object.

inherited

updateChannel(String channelId, MmUpdateChannelRequest mmUpdateChannelRequest) → Future<MmChannel?>

Update a channel

updateChannelMemberSchemeRoles(String channelId, String userId, MmUpdateTeamMemberSchemeRolesRequest mmUpdateTeamMemberSchemeRolesRequest) → Future<MmStatusOK?>

Update the scheme-derived roles of a channel member.

updateChannelMemberSchemeRolesWithHttpInfo(String channelId, String userId, MmUpdateTeamMemberSchemeRolesRequest mmUpdateTeamMemberSchemeRolesRequest) → Future<Response>

Update the scheme-derived roles of a channel member.

updateChannelNotifyProps(String channelId, String userId, MmChannelNotifyProps mmChannelNotifyProps) → Future<MmStatusOK?>

Update channel notifications

updateChannelNotifyPropsWithHttpInfo(String channelId, String userId, MmChannelNotifyProps mmChannelNotifyProps) → Future<Response>

Update channel notifications

updateChannelPrivacy(String channelId, MmUpdateChannelPrivacyRequest mmUpdateChannelPrivacyRequest) → Future<MmChannel?>

Update channel's privacy

updateChannelPrivacyWithHttpInfo(String channelId, MmUpdateChannelPrivacyRequest mmUpdateChannelPrivacyRequest) → Future<Response>

Update channel's privacy

updateChannelRoles(String channelId, String userId, MmUpdateUserRolesRequest mmUpdateUserRolesRequest) → Future<MmStatusOK?>

Update channel roles

updateChannelRolesWithHttpInfo(String channelId, String userId, MmUpdateUserRolesRequest mmUpdateUserRolesRequest) → Future<Response>

Update channel roles

updateChannelScheme(String channelId, MmUpdateTeamSchemeRequest mmUpdateTeamSchemeRequest) → Future<MmStatusOK?>

Set a channel's scheme

updateChannelSchemeWithHttpInfo(String channelId, MmUpdateTeamSchemeRequest mmUpdateTeamSchemeRequest) → Future<Response>

Set a channel's scheme

updateChannelWithHttpInfo(String channelId, MmUpdateChannelRequest mmUpdateChannelRequest) → Future<Response>

Update a channel

updateSidebarCategoriesForTeamForUser(String teamId, String userId, List<MmSidebarCategory> mmSidebarCategory) → Future<MmSidebarCategory?>

Update user's sidebar categories

updateSidebarCategoriesForTeamForUserWithHttpInfo(String teamId, String userId, List<MmSidebarCategory> mmSidebarCategory) → Future<Response>

Update user's sidebar categories

updateSidebarCategoryForTeamForUser(String teamId, String userId, String categoryId, MmSidebarCategory mmSidebarCategory) → Future<MmSidebarCategory?>

Update sidebar category

updateSidebarCategoryForTeamForUserWithHttpInfo(String teamId, String userId, String categoryId, MmSidebarCategory mmSidebarCategory) → Future<Response>

Update sidebar category

updateSidebarCategoryOrderForTeamForUser(String teamId, String userId, List<String> requestBody) → Future<List<String>?>

Update user's sidebar category order

updateSidebarCategoryOrderForTeamForUserWithHttpInfo(String teamId, String userId, List<String> requestBody) → Future<Response>

Update user's sidebar category order

viewChannel(String userId, MmViewChannelRequest mmViewChannelRequest) → Future<MmViewChannel200Response?>

View channel

viewChannelWithHttpInfo(String userId, MmViewChannelRequest mmViewChannelRequest) → Future<Response>

View channel

Operators

operator ==(Object other) → bool

The equality operator.

inherited