Struct wechaty_puppet::puppet::Puppet

pub struct Puppet<T> where
    T: 'static + PuppetImpl + Clone + Unpin + Send + Sync,  { /* fields omitted */ }

Implementations

impl<T> Puppet<T> where
    T: 'static + PuppetImpl + Clone + Unpin + Send + Sync, 

pub fn new(puppet_impl: T) -> Self

pub fn self_addr(&self) -> Recipient<PuppetEvent>

pub fn get_subscribe_addr(&self) -> Recipient<Subscribe>

pub fn get_unsubscribe_addr(&self) -> Recipient<UnSubscribe>

pub fn self_id(self) -> Option<String>

pub fn log_on_off(self) -> bool

pub async fn contact_payload(
    &self,
    contact_id: String
) -> Result<ContactPayload, PuppetError>

Load a contact by id.

pub async fn contact_search_by_string(
    &mut self,
    query_str: String,
    search_id_list: Option<Vec<String>>
) -> Result<Vec<String>, PuppetError>

Search contacts by string.

Return all contacts that has an alias or name that matches the query string.

pub async fn contact_search(
    &mut self,
    query: ContactQueryFilter,
    contact_id_list: Option<Vec<String>>
) -> Result<Vec<String>, PuppetError>

Search contacts by query.

pub async fn message_payload(
    &self,
    message_id: String
) -> Result<MessagePayload, PuppetError>

Load a message by id.

pub fn message_list(&self) -> Vec<String>

Get all cached messages.

pub async fn message_search(
    &mut self,
    query: MessageQueryFilter
) -> Result<Vec<String>, PuppetError>

pub async fn message_forward(
    &mut self,
    conversation_id: String,
    message_id: String
) -> Result<Option<String>, PuppetError>

pub async fn friendship_search(
    &mut self,
    query: FriendshipSearchQueryFilter
) -> Result<Option<String>, PuppetError>

Search friendship.

First search by phone, then search by weixin.

pub async fn friendship_payload(
    &self,
    friendship_id: String
) -> Result<FriendshipPayload, PuppetError>

Load a friendship by id.

pub async fn friendship_payload_set(
    &mut self,
    friendship_id: String,
    new_payload: FriendshipPayload
) -> Result<(), PuppetError>

Friendship payload setter.

pub async fn room_invitation_payload(
    &self,
    room_invitation_id: String
) -> Result<RoomInvitationPayload, PuppetError>

Load a room invitation by id.

pub async fn room_invitation_payload_set(
    &mut self,
    room_invitation_id: String,
    new_payload: RoomInvitationPayload
) -> Result<(), PuppetError>

Room invitation payload setter.

pub async fn room_payload(
    &self,
    room_id: String
) -> Result<RoomPayload, PuppetError>

Load a room by id.

pub async fn room_member_search_by_string(
    &mut self,
    room_id: String,
    query_str: String
) -> Result<Vec<String>, PuppetError>

Search room members by string.

pub async fn room_member_search(
    &mut self,
    room_id: String,
    query: RoomMemberQueryFilter
) -> Result<Vec<String>, PuppetError>

Search room members.

Currently, searching by contact alias is not supported.

pub async fn room_member_payload(
    &self,
    room_id: String,
    member_id: String
) -> Result<RoomMemberPayload, PuppetError>

Load a room member by room id and payload id.

pub async fn room_search(
    &mut self,
    query: RoomQueryFilter
) -> Result<Vec<String>, PuppetError>

pub async fn dirty_payload(
    &mut self,
    payload_type: PayloadType,
    id: String
) -> Result<(), PuppetError>

Trait Implementations

impl<T: Clone> Clone for Puppet<T> where
    T: 'static + PuppetImpl + Clone + Unpin + Send + Sync, 

fn clone(&self) -> Puppet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> PuppetImpl for Puppet<T> where
    T: 'static + PuppetImpl + Clone + Unpin + Send + Sync, 

fn contact_self_name_set<'life0, 'async_trait>(
    &'life0 self,
    name: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_self_qr_code<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_self_signature_set<'life0, 'async_trait>(
    &'life0 self,
    signature: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn tag_contact_add<'life0, 'async_trait>(
    &'life0 self,
    tag_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn tag_contact_remove<'life0, 'async_trait>(
    &'life0 self,
    tag_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn tag_contact_delete<'life0, 'async_trait>(
    &'life0 self,
    tag_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn tag_contact_list<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn tag_list<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_alias<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_alias_set<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    alias: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_avatar<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<FileBox, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_avatar_set<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    file: FileBox
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_phone_set<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    phone_list: Vec<String>
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_corporation_remark_set<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    corporation_remark: Option<String>
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_description_set<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    description: Option<String>
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_list<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn contact_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<ContactPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_contact<'life0, 'async_trait>(
    &'life0 self,
    message_id: String
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_file<'life0, 'async_trait>(
    &'life0 self,
    message_id: String
) -> Pin<Box<dyn Future<Output = Result<FileBox, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_image<'life0, 'async_trait>(
    &'life0 self,
    message_id: String,
    image_type: ImageType
) -> Pin<Box<dyn Future<Output = Result<FileBox, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_mini_program<'life0, 'async_trait>(
    &'life0 self,
    message_id: String
) -> Pin<Box<dyn Future<Output = Result<MiniProgramPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_url<'life0, 'async_trait>(
    &'life0 self,
    message_id: String
) -> Pin<Box<dyn Future<Output = Result<UrlLinkPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_send_contact<'life0, 'async_trait>(
    &'life0 self,
    conversation_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_send_file<'life0, 'async_trait>(
    &'life0 self,
    conversation_id: String,
    file: FileBox
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_send_mini_program<'life0, 'async_trait>(
    &'life0 self,
    conversation_id: String,
    mini_program_payload: MiniProgramPayload
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_send_text<'life0, 'async_trait>(
    &'life0 self,
    conversation_id: String,
    text: String,
    mention_id_list: Vec<String>
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_send_url<'life0, 'async_trait>(
    &'life0 self,
    conversation_id: String,
    url_link_payload: UrlLinkPayload
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn message_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    message_id: String
) -> Pin<Box<dyn Future<Output = Result<MessagePayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn friendship_accept<'life0, 'async_trait>(
    &'life0 self,
    friendship_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn friendship_add<'life0, 'async_trait>(
    &'life0 self,
    contact_id: String,
    hello: Option<String>
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn friendship_search_phone<'life0, 'async_trait>(
    &'life0 self,
    phone: String
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn friendship_search_weixin<'life0, 'async_trait>(
    &'life0 self,
    weixin: String
) -> Pin<Box<dyn Future<Output = Result<Option<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn friendship_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    friendship_id: String
) -> Pin<Box<dyn Future<Output = Result<FriendshipPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_invitation_accept<'life0, 'async_trait>(
    &'life0 self,
    room_invitation_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_invitation_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    room_invitation_id: String
) -> Pin<Box<dyn Future<Output = Result<RoomInvitationPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_add<'life0, 'async_trait>(
    &'life0 self,
    room_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_avatar<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<FileBox, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_create<'life0, 'async_trait>(
    &'life0 self,
    contact_id_list: Vec<String>,
    topic: Option<String>
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_del<'life0, 'async_trait>(
    &'life0 self,
    room_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_qr_code<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_quit<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_topic<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_topic_set<'life0, 'async_trait>(
    &'life0 self,
    room_id: String,
    topic: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_list<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<RoomPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_announce<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_announce_set<'life0, 'async_trait>(
    &'life0 self,
    room_id: String,
    text: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_member_list<'life0, 'async_trait>(
    &'life0 self,
    room_id: String
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn room_member_raw_payload<'life0, 'async_trait>(
    &'life0 self,
    room_id: String,
    contact_id: String
) -> Pin<Box<dyn Future<Output = Result<RoomMemberPayload, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn start<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn stop<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn ding<'life0, 'async_trait>(
    &'life0 self,
    data: String
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn version<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<String, PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn logout<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), PuppetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,