Struct threema_gateway::SimpleApi
[−]
[src]
pub struct SimpleApi { /* fields omitted */ }Struct to talk to the simple API (without end-to-end encryption).
Methods
impl SimpleApi[src]
pub fn send(&self, to: &Recipient, text: &str) -> Result<String, ApiError>[src]
Send a message to the specified recipient in basic mode.
Note that this mode of sending messages does not provide end-to-end encryption, only transport encryption between your host and the Threema Gateway server.
Cost: 1 credit.
pub fn lookup_pubkey(&self, id: &str) -> Result<String, ApiError>[src]
Fetch the public key for the specified Threema ID.
For the end-to-end encrypted mode, you need the public key of the recipient in order to encrypt a message. While it's best to obtain this directly from the recipient (extract it from the QR code), this may not be convenient, and therefore you can also look up the key associated with a given ID from the server.
It is strongly recommended that you cache the public keys to avoid querying the API for each message.
pub fn lookup_id(&self, criterion: &LookupCriterion) -> Result<String, ApiError>[src]
Look up a Threema ID in the directory.
An ID can be looked up either by a phone number or an e-mail
address, in plaintext or hashed form. You can specify one of those
criteria using the LookupCriterion
enum.
pub fn lookup_capabilities(&self, id: &str) -> Result<Capabilities, ApiError>[src]
Look up the capabilities of a certain Threema ID.
Before you send a file to a Threema ID using the blob upload (+file message), you may want to check whether the recipient uses a Threema version that supports receiving files. The receiver may be using an old version, or a platform where file reception is not supported.
pub fn lookup_credits(&self) -> Result<i64, ApiError>[src]
Look up a remaining gateway credits.
Trait Implementations
impl Debug for SimpleApi[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result[src]
Formats the value using the given formatter. Read more
impl Clone for SimpleApi[src]
fn clone(&self) -> SimpleApi[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl PartialEq for SimpleApi[src]
fn eq(&self, __arg_0: &SimpleApi) -> bool[src]
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, __arg_0: &SimpleApi) -> bool[src]
This method tests for !=.