Enum IncludeSubscribers 

pub enum IncludeSubscribers {
    False,
    True,
    Partial,
}

Whether each returned channel object should include a subscribers field containing a list of the user IDs of its subscribers.

Client apps supporting organizations with many thousands of users should not pass true, because the full subscriber matrix may be several megabytes of data. The partial value, combined with the subscriber_count and fetching subscribers for individual channels as needed, is recommended to support client app features where channel subscriber data is useful.

If a client passes partial for this parameter, the server may, for some channels, return a subset of the channel’s subscribers in the partial_subscribers field instead of the subscribers field, which always contains the complete set of subscribers.

The server guarantees that it will always return a subscribers field for channels with fewer than 250 total subscribers. When returning a partial_subscribers field, the server guarantees that all bot users and users active within the last 14 days will be included. For other cases, the server may use its discretion to determine which channels and users to include, balancing between payload size and usefulness of the data provided to the client.

Passing true in an unauthenticated request is an error.

Changes: The partial value is new in Zulip 11.0 (feature level 412).

Before Zulip 6.0 (feature level 149), this parameter was silently ignored and processed as though it were false in unauthenticated requests.

New in Zulip 2.1.0.

Variants

False

True

Partial

Implementations

impl IncludeSubscribers

pub const fn new() -> Self

Creates a new IncludeSubscribers.

Trait Implementations

impl Clone for IncludeSubscribers

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for IncludeSubscribers

impl Debug for IncludeSubscribers

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

Formats the value using the given formatter.

impl Default for IncludeSubscribers

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncludeSubscribers

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IncludeSubscribers

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

Formats the value using the given formatter.

impl Eq for IncludeSubscribers

impl PartialEq for IncludeSubscribers

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for IncludeSubscribers

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IncludeSubscribers