mattermost-clj.api.channels — mattermost-clj 4.0.3

channels-channel-id-convert-post clj

(channels-channel-id-convert-post channel-id)

Convert a channel from public to private Convert into private channel from the provided channel id string.

Minimum server version: 4.10

Permissions

manage_team permission for the team of the channel.

channels-channel-id-convert-post-with-http-info clj

(channels-channel-id-convert-post-with-http-info channel-id)

Convert a channel from public to private Convert into private channel from the provided channel id string.

Minimum server version: 4.10

Permissions

manage_team permission for the team of the channel.

channels-channel-id-delete clj

(channels-channel-id-delete channel-id)

Delete a channel Soft deletes a channel, by marking the channel as deleted in the database. Soft deleted channels will not be accessible in the user interface. Direct and group message channels cannot be deleted.

Permissions

delete_public_channel permission if the channel is public, delete_private_channel permission if the channel is private, or have manage_system permission.

channels-channel-id-delete-with-http-info clj

(channels-channel-id-delete-with-http-info channel-id)

Delete a channel Soft deletes a channel, by marking the channel as deleted in the database. Soft deleted channels will not be accessible in the user interface. Direct and group message channels cannot be deleted.

Permissions

delete_public_channel permission if the channel is public, delete_private_channel permission if the channel is private, or have manage_system permission.

channels-channel-id-get clj

(channels-channel-id-get channel-id)

Get a channel Get channel from the provided channel id string.

Permissions

read_channel permission for the channel.

channels-channel-id-get-with-http-info clj

(channels-channel-id-get-with-http-info channel-id)

Get a channel Get channel from the provided channel id string.

Permissions

read_channel permission for the channel.

channels-channel-id-members-get clj

(channels-channel-id-members-get channel-id)

(channels-channel-id-members-get channel-id optional-params)

Get channel members Get a page of members for a channel.

Permissions

read_channel permission for the channel.

channels-channel-id-members-get-with-http-info clj

(channels-channel-id-members-get-with-http-info channel-id)

(channels-channel-id-members-get-with-http-info channel-id
                                                {:keys [page per-page]})

Get channel members Get a page of members for a channel.

Permissions

read_channel permission for the channel.

channels-channel-id-members-ids-post clj

(channels-channel-id-members-ids-post channel-id string)

Get channel members by ids Get a list of channel members based on the provided user ids.

Permissions

Must have the read_channel permission.

channels-channel-id-members-ids-post-with-http-info clj

(channels-channel-id-members-ids-post-with-http-info channel-id string)

Get channel members by ids Get a list of channel members based on the provided user ids.

Permissions

Must have the read_channel permission.

channels-channel-id-members-minus-group-members-get clj

(channels-channel-id-members-minus-group-members-get channel-id group-ids)

(channels-channel-id-members-minus-group-members-get channel-id
                                                     group-ids
                                                     optional-params)

Channel members minus group members. Get the set of users who are members of the channel minus the set of users who are members of the given groups. Each user object contains an array of group objects representing the group memberships for that user. Each user object contains the boolean fields scheme_guest, scheme_user, and scheme_admin representing the roles that user has for the given channel.

Permissions

Must have manage_system permission.

Minimum server version: 5.14

channels-channel-id-members-minus-group-members-get-with-http-info clj

(channels-channel-id-members-minus-group-members-get-with-http-info channel-id
                                                                    group-ids)

(channels-channel-id-members-minus-group-members-get-with-http-info
  channel-id
  group-ids
  {:keys [page per-page]})

Channel members minus group members. Get the set of users who are members of the channel minus the set of users who are members of the given groups. Each user object contains an array of group objects representing the group memberships for that user. Each user object contains the boolean fields scheme_guest, scheme_user, and scheme_admin representing the roles that user has for the given channel.

Permissions

Must have manage_system permission.

Minimum server version: 5.14

channels-channel-id-members-post clj

(channels-channel-id-members-post channel-id)

(channels-channel-id-members-post channel-id optional-params)

Add user to channel Add a user to a channel by creating a channel member object.

channels-channel-id-members-post-with-http-info clj

(channels-channel-id-members-post-with-http-info channel-id)

(channels-channel-id-members-post-with-http-info channel-id
                                                 {:keys [inline-object-37]})

Add user to channel Add a user to a channel by creating a channel member object.

channels-channel-id-members-user-id-delete clj

(channels-channel-id-members-user-id-delete channel-id user-id)

Remove user from channel Delete a channel member, effectively removing them from a channel.

In server version 5.3 and later, channel members can only be deleted from public or private channels.

Permissions

manage_public_channel_members permission if the channel is public. manage_private_channel_members permission if the channel is private.

channels-channel-id-members-user-id-delete-with-http-info clj

(channels-channel-id-members-user-id-delete-with-http-info channel-id user-id)

Remove user from channel Delete a channel member, effectively removing them from a channel.

In server version 5.3 and later, channel members can only be deleted from public or private channels.

Permissions

manage_public_channel_members permission if the channel is public. manage_private_channel_members permission if the channel is private.

channels-channel-id-members-user-id-get clj

(channels-channel-id-members-user-id-get channel-id user-id)

Get channel member Get a channel member.

Permissions

read_channel permission for the channel.

channels-channel-id-members-user-id-get-with-http-info clj

(channels-channel-id-members-user-id-get-with-http-info channel-id user-id)

Get channel member Get a channel member.

Permissions

read_channel permission for the channel.

channels-channel-id-members-user-id-notify-props-put clj

(channels-channel-id-members-user-id-notify-props-put channel-id
                                                      user-id
                                                      channel-notify-props)

Update channel notifications Update a user's notification properties for a channel. Only the provided fields are updated.

Permissions

Must be logged in as the user or have edit_other_users permission.

channels-channel-id-members-user-id-notify-props-put-with-http-info clj

(channels-channel-id-members-user-id-notify-props-put-with-http-info
  channel-id
  user-id
  channel-notify-props)

Update channel notifications Update a user's notification properties for a channel. Only the provided fields are updated.

Permissions

Must be logged in as the user or have edit_other_users permission.

channels-channel-id-members-user-id-roles-put clj

(channels-channel-id-members-user-id-roles-put channel-id user-id)

(channels-channel-id-members-user-id-roles-put channel-id
                                               user-id
                                               optional-params)

Update channel roles Update a user's roles for a channel.

Permissions

Must have manage_channel_roles permission for the channel.

channels-channel-id-members-user-id-roles-put-with-http-info clj

(channels-channel-id-members-user-id-roles-put-with-http-info channel-id
                                                              user-id)

(channels-channel-id-members-user-id-roles-put-with-http-info
  channel-id
  user-id
  {:keys [inline-object-38]})

Update channel roles Update a user's roles for a channel.

Permissions

Must have manage_channel_roles permission for the channel.

channels-channel-id-members-user-id-scheme-roles-put clj

(channels-channel-id-members-user-id-scheme-roles-put channel-id user-id)

(channels-channel-id-members-user-id-scheme-roles-put channel-id
                                                      user-id
                                                      optional-params)

Update the scheme-derived roles of a channel member. Update a channel member's scheme_admin/scheme_user properties. Typically this should either be scheme_admin=false, scheme_user=true for ordinary channel member, or scheme_admin=true, scheme_user=true for a channel admin. Minimum server version: 5.0

Permissions

Must be authenticated and have the manage_channel_roles permission.

channels-channel-id-members-user-id-scheme-roles-put-with-http-info clj

(channels-channel-id-members-user-id-scheme-roles-put-with-http-info channel-id
                                                                     user-id)

(channels-channel-id-members-user-id-scheme-roles-put-with-http-info
  channel-id
  user-id
  {:keys [inline-object-39]})

Update the scheme-derived roles of a channel member. Update a channel member's scheme_admin/scheme_user properties. Typically this should either be scheme_admin=false, scheme_user=true for ordinary channel member, or scheme_admin=true, scheme_user=true for a channel admin. Minimum server version: 5.0

Permissions

Must be authenticated and have the manage_channel_roles permission.

channels-channel-id-patch-put clj

(channels-channel-id-patch-put channel-id)

(channels-channel-id-patch-put channel-id optional-params)

Patch a channel Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

channels-channel-id-patch-put-with-http-info clj

(channels-channel-id-patch-put-with-http-info channel-id)

(channels-channel-id-patch-put-with-http-info channel-id
                                              {:keys [inline-object-35]})

Patch a channel Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

channels-channel-id-pinned-get clj

(channels-channel-id-pinned-get channel-id)

Get a channel's pinned posts Get a list of pinned posts for channel.

channels-channel-id-pinned-get-with-http-info clj

(channels-channel-id-pinned-get-with-http-info channel-id)

Get a channel's pinned posts Get a list of pinned posts for channel.

channels-channel-id-put clj

(channels-channel-id-put channel-id)

(channels-channel-id-put channel-id optional-params)

Update a channel Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.

Permissions

If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

channels-channel-id-put-with-http-info clj

(channels-channel-id-put-with-http-info channel-id)

(channels-channel-id-put-with-http-info channel-id {:keys [inline-object-34]})

Update a channel Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.

Permissions

If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

channels-channel-id-restore-post clj

(channels-channel-id-restore-post channel-id)

Restore a channel Restore channel from the provided channel id string.

Minimum server version: 3.10

Permissions

manage_team permission for the team of the channel.

channels-channel-id-restore-post-with-http-info clj

(channels-channel-id-restore-post-with-http-info channel-id)

Restore a channel Restore channel from the provided channel id string.

Minimum server version: 3.10

Permissions

manage_team permission for the team of the channel.

channels-channel-id-scheme-put clj

(channels-channel-id-scheme-put channel-id)

(channels-channel-id-scheme-put channel-id optional-params)

Set a channel's scheme Set a channel's scheme, more specifically sets the scheme_id value of a channel record.

Permissions

Must have manage_system permission.

Minimum server version: 4.10

channels-channel-id-scheme-put-with-http-info clj

(channels-channel-id-scheme-put-with-http-info channel-id)

(channels-channel-id-scheme-put-with-http-info channel-id
                                               {:keys [inline-object-41]})

Set a channel's scheme Set a channel's scheme, more specifically sets the scheme_id value of a channel record.

Permissions

Must have manage_system permission.

Minimum server version: 4.10

channels-channel-id-stats-get clj

(channels-channel-id-stats-get channel-id)

Get channel statistics Get statistics for a channel.

Permissions

Must have the read_channel permission.

channels-channel-id-stats-get-with-http-info clj

(channels-channel-id-stats-get-with-http-info channel-id)

Get channel statistics Get statistics for a channel.

Permissions

Must have the read_channel permission.

channels-channel-id-timezones-get clj

(channels-channel-id-timezones-get channel-id)

Get timezones in a channel Get a list of timezones for the users who are in this channel.

Minimum server version: 5.6

Permissions

Must have the read_channel permission.

channels-channel-id-timezones-get-with-http-info clj

(channels-channel-id-timezones-get-with-http-info channel-id)

Get timezones in a channel Get a list of timezones for the users who are in this channel.

Minimum server version: 5.6

Permissions

Must have the read_channel permission.

channels-direct-post clj

(channels-direct-post string)

Create a direct message channel Create a new direct message channel between two users.

Permissions

Must be one of the two users and have create_direct_channel permission. Having the manage_system permission voids the previous requirements.

channels-direct-post-with-http-info clj

(channels-direct-post-with-http-info string)

Create a direct message channel Create a new direct message channel between two users.

Permissions

Must be one of the two users and have create_direct_channel permission. Having the manage_system permission voids the previous requirements.

channels-group-post clj

(channels-group-post string)

Create a group message channel Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.

Permissions

Must have create_group_channel permission.

channels-group-post-with-http-info clj

(channels-group-post-with-http-info string)

Create a group message channel Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.

Permissions

Must have create_group_channel permission.

channels-members-user-id-view-post clj

(channels-members-user-id-view-post user-id)

(channels-members-user-id-view-post user-id optional-params)

View channel Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.

Permissions

Must be logged in as user or have edit_other_users permission.

Response only includes last_viewed_at_times in Mattermost server 4.3 and newer.

channels-members-user-id-view-post-with-http-info clj

(channels-members-user-id-view-post-with-http-info user-id)

(channels-members-user-id-view-post-with-http-info user-id
                                                   {:keys [inline-object-40]})

View channel Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.

Permissions

Must be logged in as user or have edit_other_users permission.

Response only includes last_viewed_at_times in Mattermost server 4.3 and newer.

channels-post clj

(channels-post)

(channels-post optional-params)

Create a channel Create a new channel.

Permissions

If creating a public channel, create_public_channel permission is required. If creating a private channel, create_private_channel permission is required.

channels-post-with-http-info clj

(channels-post-with-http-info)

(channels-post-with-http-info {:keys [inline-object-32]})

Create a channel Create a new channel.

Permissions

If creating a public channel, create_public_channel permission is required. If creating a private channel, create_private_channel permission is required.

group-search-post clj

(group-search-post)

(group-search-post optional-params)

Search Group Channels Get a list of group channels for a user which members' usernames match the search term.

Minimum server version: 5.14

group-search-post-with-http-info clj

(group-search-post-with-http-info)

(group-search-post-with-http-info {:keys [inline-object-33]})

Search Group Channels Get a list of group channels for a user which members' usernames match the search term.

Minimum server version: 5.14

teams-name-team-name-channels-name-channel-name-get clj

(teams-name-team-name-channels-name-channel-name-get team-name channel-name)

(teams-name-team-name-channels-name-channel-name-get team-name
                                                     channel-name
                                                     optional-params)

Get a channel by name and team name Gets a channel from the provided team name and channel name strings.

Permissions

read_channel permission for the channel.

teams-name-team-name-channels-name-channel-name-get-with-http-info clj

(teams-name-team-name-channels-name-channel-name-get-with-http-info
  team-name
  channel-name)

(teams-name-team-name-channels-name-channel-name-get-with-http-info
  team-name
  channel-name
  {:keys [include-deleted]})

Get a channel by name and team name Gets a channel from the provided team name and channel name strings.

Permissions

read_channel permission for the channel.

teams-team-id-channels-autocomplete-get clj

(teams-team-id-channels-autocomplete-get team-id name)

Autocomplete channels Autocomplete public channels on a team based on the search term provided in the request URL.

Minimum server version: 4.7

Permissions

Must have the list_team_channels permission.

teams-team-id-channels-autocomplete-get-with-http-info clj

(teams-team-id-channels-autocomplete-get-with-http-info team-id name)

Autocomplete channels Autocomplete public channels on a team based on the search term provided in the request URL.

Minimum server version: 4.7

Permissions

Must have the list_team_channels permission.

teams-team-id-channels-deleted-get clj

(teams-team-id-channels-deleted-get team-id)

(teams-team-id-channels-deleted-get team-id optional-params)

Get deleted channels Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.

Minimum server version: 3.10

Permissions

Must be authenticated and have the manage_team permission.

teams-team-id-channels-deleted-get-with-http-info clj

(teams-team-id-channels-deleted-get-with-http-info team-id)

(teams-team-id-channels-deleted-get-with-http-info team-id
                                                   {:keys [page per-page]})

Get deleted channels Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.

Minimum server version: 3.10

Permissions

Must be authenticated and have the manage_team permission.

teams-team-id-channels-get clj

(teams-team-id-channels-get team-id)

(teams-team-id-channels-get team-id optional-params)

Get public channels Get a page of public channels on a team based on query string parameters - page and per_page.

Permissions

Must be authenticated and have the list_team_channels permission.

teams-team-id-channels-get-with-http-info clj

(teams-team-id-channels-get-with-http-info team-id)

(teams-team-id-channels-get-with-http-info team-id {:keys [page per-page]})

Get public channels Get a page of public channels on a team based on query string parameters - page and per_page.

Permissions

Must be authenticated and have the list_team_channels permission.

teams-team-id-channels-ids-post clj

(teams-team-id-channels-ids-post team-id string)

Get a list of channels by ids Get a list of public channels on a team by id.

Permissions

view_team for the team the channels are on.

teams-team-id-channels-ids-post-with-http-info clj

(teams-team-id-channels-ids-post-with-http-info team-id string)

Get a list of channels by ids Get a list of public channels on a team by id.

Permissions

view_team for the team the channels are on.

teams-team-id-channels-name-channel-name-get clj

(teams-team-id-channels-name-channel-name-get team-id channel-name)

(teams-team-id-channels-name-channel-name-get team-id
                                              channel-name
                                              optional-params)

Get a channel by name Gets channel from the provided team id and channel name strings.

Permissions

read_channel permission for the channel.

teams-team-id-channels-name-channel-name-get-with-http-info clj

(teams-team-id-channels-name-channel-name-get-with-http-info team-id
                                                             channel-name)

(teams-team-id-channels-name-channel-name-get-with-http-info
  team-id
  channel-name
  {:keys [include-deleted]})

Get a channel by name Gets channel from the provided team id and channel name strings.

Permissions

read_channel permission for the channel.

teams-team-id-channels-search-autocomplete-get clj

(teams-team-id-channels-search-autocomplete-get team-id name)

Autocomplete channels for search Autocomplete your channels on a team based on the search term provided in the request URL.

Minimum server version: 5.4

Permissions

Must have the list_team_channels permission.

teams-team-id-channels-search-autocomplete-get-with-http-info clj

(teams-team-id-channels-search-autocomplete-get-with-http-info team-id name)

Autocomplete channels for search Autocomplete your channels on a team based on the search term provided in the request URL.

Minimum server version: 5.4

Permissions

Must have the list_team_channels permission.

teams-team-id-channels-search-post clj

(teams-team-id-channels-search-post team-id)

(teams-team-id-channels-search-post team-id optional-params)

Search channels Search public channels on a team based on the search term provided in the request body.

Permissions

Must have the list_team_channels permission.

In server version 5.16 and later, a user without the list_team_channels permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

teams-team-id-channels-search-post-with-http-info clj

(teams-team-id-channels-search-post-with-http-info team-id)

(teams-team-id-channels-search-post-with-http-info team-id
                                                   {:keys [inline-object-36]})

Search channels Search public channels on a team based on the search term provided in the request body.

Permissions

Must have the list_team_channels permission.

In server version 5.16 and later, a user without the list_team_channels permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

users-user-id-channels-channel-id-unread-get clj

(users-user-id-channels-channel-id-unread-get user-id channel-id)

Get unread messages Get the total unread messages and mentions for a channel for a user.

Permissions

Must be logged in as user and have the read_channel permission, or have edit_other_usrs permission.

users-user-id-channels-channel-id-unread-get-with-http-info clj

(users-user-id-channels-channel-id-unread-get-with-http-info user-id channel-id)

Get unread messages Get the total unread messages and mentions for a channel for a user.

Permissions

Must be logged in as user and have the read_channel permission, or have edit_other_usrs permission.

users-user-id-teams-team-id-channels-get clj

(users-user-id-teams-team-id-channels-get user-id team-id)

Get channels for user Get all the channels on a team for a user.

Permissions

Logged in as the user, or have edit_other_users permission, and view_team permission for the team.

users-user-id-teams-team-id-channels-get-with-http-info clj

(users-user-id-teams-team-id-channels-get-with-http-info user-id team-id)

Get channels for user Get all the channels on a team for a user.

Permissions

Logged in as the user, or have edit_other_users permission, and view_team permission for the team.

users-user-id-teams-team-id-channels-members-get clj

(users-user-id-teams-team-id-channels-members-get user-id team-id)

Get channel members for user Get all channel members on a team for a user.

Permissions

Logged in as the user and view_team permission for the team. Having manage_system permission voids the previous requirements.

users-user-id-teams-team-id-channels-members-get-with-http-info clj

(users-user-id-teams-team-id-channels-members-get-with-http-info user-id
                                                                 team-id)

Get channel members for user Get all channel members on a team for a user.

Permissions

Logged in as the user and view_team permission for the team. Having manage_system permission voids the previous requirements.