Skip to main content

AdminConversationsSearchRequest

Struct AdminConversationsSearchRequest 

Source
#[non_exhaustive]
pub struct AdminConversationsSearchRequest { pub team_ids: Option<Vec<String>>, pub connected_team_ids: Option<Vec<String>>, pub query: Option<String>, pub limit: Option<i64>, pub cursor: Option<String>, pub search_channel_types: Option<Vec<String>>, pub sort: Option<String>, pub sort_dir: Option<String>, pub total_count_only: Option<bool>, }
Expand description

Arguments for the Slack Web API method admin.conversations.search: Search for public or private channels in an Enterprise organization.

Send it with SlackClient::admin_conversations_search.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§team_ids: Option<Vec<String>>

Comma separated string of team IDs, signifying the internal workspaces to search through.

§connected_team_ids: Option<Vec<String>>

Array of encoded team IDs, signifying the external orgs to search through.

§query: Option<String>

Name of the the channel to query by.

§limit: Option<i64>

Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.

§cursor: Option<String>

Set cursor to next_cursor returned by the previous call to list items in the next page.

§search_channel_types: Option<Vec<String>>

The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.

§sort: Option<String>

Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted

§sort_dir: Option<String>

Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a)

§total_count_only: Option<bool>

Only return the total_count of channels. Omits channel data and allows access for admins without channel manager permissions.

Implementations§

Source§

impl AdminConversationsSearchRequest

Source

pub fn new() -> Self

Source

pub fn team_ids(self, team_ids: Vec<String>) -> Self

Source

pub fn connected_team_ids(self, connected_team_ids: Vec<String>) -> Self

Source

pub fn query(self, query: impl Into<String>) -> Self

Source

pub fn limit(self, limit: i64) -> Self

Source

pub fn cursor(self, cursor: impl Into<String>) -> Self

Source

pub fn search_channel_types(self, search_channel_types: Vec<String>) -> Self

Source

pub fn sort(self, sort: impl Into<String>) -> Self

Source

pub fn sort_dir(self, sort_dir: impl Into<String>) -> Self

Source

pub fn total_count_only(self, total_count_only: bool) -> Self

Trait Implementations§

Source§

impl Clone for AdminConversationsSearchRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CursorPaginated for AdminConversationsSearchRequest

Source§

fn set_cursor(&mut self, cursor: String)

Source§

impl Debug for AdminConversationsSearchRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AdminConversationsSearchRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AdminConversationsSearchRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for AdminConversationsSearchRequest

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl SlackApiMethod for AdminConversationsSearchRequest

Source§

const METHOD: &'static str = "admin.conversations.search"

Method name, such as chat.postMessage.
Source§

type Response = AdminConversationsSearchResponse

Type of a successful response.
Source§

impl StructuralPartialEq for AdminConversationsSearchRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more