Struct threema_gateway::SimpleApi
source · pub struct SimpleApi { /* private fields */ }
Expand description
Struct to talk to the simple API (without end-to-end encryption).
Implementations
sourceimpl SimpleApi
impl SimpleApi
sourcepub fn send(&self, to: &Recipient<'_>, text: &str) -> Result<String, ApiError>
pub fn send(&self, to: &Recipient<'_>, text: &str) -> Result<String, ApiError>
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.
sourcepub fn lookup_pubkey(&self, id: &str) -> Result<String, ApiError>
pub fn lookup_pubkey(&self, id: &str) -> Result<String, ApiError>
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.
sourcepub fn lookup_id(&self, criterion: &LookupCriterion) -> Result<String, ApiError>
pub fn lookup_id(&self, criterion: &LookupCriterion) -> Result<String, ApiError>
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.
sourcepub fn lookup_capabilities(&self, id: &str) -> Result<Capabilities, ApiError>
pub fn lookup_capabilities(&self, id: &str) -> Result<Capabilities, ApiError>
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.
sourcepub fn lookup_credits(&self) -> Result<i64, ApiError>
pub fn lookup_credits(&self) -> Result<i64, ApiError>
Look up a remaining gateway credits.
Trait Implementations
impl Eq for SimpleApi
impl StructuralEq for SimpleApi
impl StructuralPartialEq for SimpleApi
Auto Trait Implementations
impl RefUnwindSafe for SimpleApi
impl Send for SimpleApi
impl Sync for SimpleApi
impl Unpin for SimpleApi
impl UnwindSafe for SimpleApi
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.