Struct ChannelPermission 

pub struct ChannelPermission {
    pub name: String,
    pub bits: u8,
}

Channel permission.

Single channel permission information.

Example

let channel_permission = // Channel
    .get()
    .manage();

Fields

name: String

Name of channel for which permission level specified.

bits: u8

Bitmask with configured permission level.

Implementations

impl ChannelPermission

Channel-based endpoint permissions.

Trait contains methods to configure permissions to access endpoints related to channels.

pub fn read(self) -> Box<Self>

Resource read permissions.

This permission for channel (including channel-pnpres) allows to:

• subscribe
• retrieve list of subscribers
• get state associated with userId
• associate state with userId
• fetch messages history
• fetch messages history with message actions
• fetch message actions
• retrieve messages count
• list files
• download files
• register for push notifications
• unregister from push notifications

pub fn write(self) -> Box<Self>

Resource write permissions.

This permission for channel allows to:

• publish message
• add message action
• send signal
• send file

pub fn delete(self) -> Box<Self>

Resource delete permissions.

This permission for channel allows to:

• delete messages
• delete message action
• delete file
• delete channel metadata

pub fn get(self) -> Box<Self>

Resource get permissions.

This permission for channel allows to:

• get channel metadata
• get channel members

pub fn update(self) -> Box<Self>

Resource update permissions.

This permission for channel allows to:

• set channel metadata

pub fn manage(self) -> Box<Self>

Resource manage permissions.

This permission for channel allows to:

• set channel members
• remove channel members

pub fn join(self) -> Box<Self>

Resource join permissions.

This permission for channel allows to:

• set channel memberships
• remove channel memberships

Trait Implementations

impl Debug for ChannelPermission

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Permission for ChannelPermission

fn id(&self) -> &String

The name or pattern of the channel name for which permissions were specified.

fn value(&self) -> &u8

Calculated channel permissions value.

fn resource_type(&self) -> ResourceType

Actual type of resource for which permission has been specified.