Struct OfficialAccount

pub struct OfficialAccount { /* private fields */ }

Implementations

impl OfficialAccount

pub fn get_redirect_url( &self, redirect_uri: String, state: Option<String>, ) -> String

Generates a URL that can be used to redirect the user to the WeChat authorization page.

The user will be redirected to the redirect_uri after authorization. The state parameter is optional and can be used to store arbitrary data that will be passed back to your application after authorization.

Examples

pub async fn get_oauth2_token( &self, code: String, ) -> Result<AccessTokenResponse, Box<dyn Error>>

Exchanges the given authorization code for an access token using the WeChat API

This function constructs a request to the WeChat OAuth2 API endpoint with the provided authorization code, app ID, and app secret, and processes the response to retrieve an access token.

Arguments

• code - A String containing the authorization code received from the WeChat authorization server.

Returns

• A Result containing an AccessTokenResponse on success, or a boxed error on failure.

Errors

• Returns an error if the HTTP request fails or returns a non-success status, or if the response cannot be deserialized into an AccessTokenResponse.

pub async fn get_userinfo( &self, openid: String, ) -> Result<UserInfoResponse, Box<dyn Error>>

Retrieves user information from WeChat API using the provided openid.

This function fetches the access token from the Redis database associated with the given openid, constructs a request to the WeChat API to get user information, and processes the response.

Arguments

• openid - A String representing the user’s unique identifier in WeChat.

Returns

• A Result containing a UserInfoResponse on success, or a boxed error on failure.

Errors

• Returns an error if the access token is not found in Redis, if the HTTP request fails or returns a non-success status, or if the response cannot be deserialized into a UserInfoResponse.

impl OfficialAccount

pub async fn delete_menu(&self) -> Result<String, Box<dyn Error>>

Deletes all custom menus for the official account

Returns

• A Result containing a String with the value "ok" on success, or a boxed error on failure.

Errors

• Returns an error if the HTTP request fails or returns a non-success status, or if the response cannot be deserialized into a BasicResponse.

impl OfficialAccount

pub async fn get_qr_ticket( &self, req: TicketRequest, ) -> Result<TicketResponse, Box<dyn Error>>

Create a QR code ticket for the official account

This function creates a QR code ticket for the official account and returns a string representing the ticket.

Errors

• Returns an error if the HTTP request fails or returns a non-success status, or if the response cannot be deserialized into a String.

impl OfficialAccount

pub async fn clear_quota(&self) -> Result<(), Box<dyn Error>>

清空api的调用quota

impl OfficialAccount

pub async fn request_validate(&self, query: WechatQuery) -> bool

Checks the signature of the WeChat request to ensure it is sent by WeChat.

Arguments

• query - A WechatQuery containing the timestamp, nonce, and signature.

Returns

• true if the signature matches, false otherwise.

impl OfficialAccount

pub async fn token(&self) -> Result<String, Box<dyn Error>>

Retrieves the access token for the official account

This function attempts to fetch the access token from the Redis database. If not found, it requests a new token from the WeChat API using the application ID and secret, then stores the token in Redis for future use.

Returns

• A Result containing the access token as a String on success, or a boxed error on failure.

Errors

• Returns an error if the Redis operation fails, if the HTTP request fails, or if the response cannot be deserialized into a TokenResponse.

impl OfficialAccount

pub fn new(conf: Config, redis_url: String) -> Self

Creates a new instance of the OfficialAccount struct.

Arguments

• appid - The appid of the WeChat application.
• app_secret - The app secret of the WeChat application.
• cfg - The URL of the Redis database connection string.

Returns

A new instance of the OfficialAccount struct.