from .base import Base
[docs]class SharedChannels(Base):
[docs] def get_all_shared_channels(self, team_id, params=None):
"""Get all shared channels for team.
team_id: Team Id
page: The page to select.
per_page: The number of sharedchannels per page.
`Read in Mattermost API docs (shared_channels - GetAllSharedChannels) <https://api.mattermost.com/#tag/shared_channels/operation/GetAllSharedChannels>`_
"""
return self.client.get(f"/api/v4/sharedchannels/{team_id}", params=params)
[docs] def get_shared_channel_remotes_by_remote_cluster(self, remote_id, params=None):
"""Get shared channel remotes by remote cluster.
remote_id: The remote cluster GUID
exclude_home: Show only those Shared channel remotes that were shared with this server
exclude_remote: Show only those Shared channel remotes that were shared from this server
page: The page to select
per_page: The number of shared channels per page
`Read in Mattermost API docs (shared_channels - GetSharedChannelRemotesByRemoteCluster) <https://api.mattermost.com/#tag/shared_channels/operation/GetSharedChannelRemotesByRemoteCluster>`_
"""
return self.client.get(f"/api/v4/remotecluster/{remote_id}/sharedchannelremotes", params=params)
[docs] def get_remote_cluster_info(self, remote_id):
"""Get remote cluster info by ID for user.
remote_id: Remote Cluster GUID
`Read in Mattermost API docs (shared_channels - GetRemoteClusterInfo) <https://api.mattermost.com/#tag/shared_channels/operation/GetRemoteClusterInfo>`_
"""
return self.client.get(f"/api/v4/sharedchannels/remote_info/{remote_id}")
[docs] def invite_remote_cluster_to_channel(self, remote_id, channel_id):
"""Invites a remote cluster to a channel.
remote_id: The remote cluster GUID
channel_id: The channel GUID to invite the remote cluster to
`Read in Mattermost API docs (shared_channels - InviteRemoteClusterToChannel) <https://api.mattermost.com/#tag/shared_channels/operation/InviteRemoteClusterToChannel>`_
"""
return self.client.post(f"/api/v4/remotecluster/{remote_id}/channels/{channel_id}/invite")
[docs] def uninvite_remote_cluster_to_channel(self, remote_id, channel_id):
"""Uninvites a remote cluster to a channel.
remote_id: The remote cluster GUID
channel_id: The channel GUID to uninvite the remote cluster to
`Read in Mattermost API docs (shared_channels - UninviteRemoteClusterToChannel) <https://api.mattermost.com/#tag/shared_channels/operation/UninviteRemoteClusterToChannel>`_
"""
return self.client.post(f"/api/v4/remotecluster/{remote_id}/channels/{channel_id}/uninvite")