egg-mode 0.15.0

Library to interact with the Twitter API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

use crate::common::*;
use crate::user::UserID;
use crate::{auth, links};

use super::*;

///Lookup a single DM by its numeric ID.
pub async fn show(id: u64, token: &auth::Token) -> Result<Response<DirectMessage>, error::Error> {
    let params = ParamList::default().add_param("id", id.to_string());
    let req = get(links::direct::SHOW, token, Some(&params));
    request_with_json_response(req).await
}

///Create a `Timeline` struct to navigate the direct messages received by the authenticated user.
pub fn received(token: &auth::Token) -> Timeline {
    Timeline::new(links::direct::RECEIVED, None, token)
}

///Create a `Timeline` struct to navigate the direct messages sent by the authenticated user.
pub fn sent(token: &auth::Token) -> Timeline {
    Timeline::new(links::direct::SENT, None, token)
}

///Send a new direct message to the given user.
///
///The recipient must allow DMs from the authenticated user for this to be successful. In practice,
///this means that the recipient must either follow the authenticated user, or they must have the
///"allow DMs from anyone" setting enabled. As the latter setting has no visibility on the API,
///there may be situations where you can't verify the recipient's ability to receive the requested
///DM beforehand.
///
///Upon successfully sending the DM, the message will be returned.
pub async fn send<T: Into<UserID>>(
    to: T,
    text: CowStr,
    token: &auth::Token,
) -> Result<Response<DirectMessage>, error::Error> {
    let params = ParamList::new()
        .add_user_param(to.into())
        .add_param("text", text);

    let req = post(links::direct::SEND, token, Some(&params));

    request_with_json_response(req).await
}

///Delete the direct message with the given ID.
///
///The authenticated user must be the sender of this DM for this call to be successful.
///
///On a successful deletion, the future returned by this function yields the freshly-deleted
///message.
pub async fn delete(id: u64, token: &auth::Token) -> Result<Response<DirectMessage>, error::Error> {
    let params = ParamList::new().add_param("id", id.to_string());
    let req = post(links::direct::DELETE, token, Some(&params));
    request_with_json_response(req).await
}

///Create a `ConversationTimeline` loader that can load direct messages as a collection of
///pre-sorted conversations.
///
///Note that this does not load any messages; you need to call `newest` or `next` for that. See
///[`ConversationTimeline`] for details.
///
///[`ConversationTimeline`]: struct.ConversationTimeline.html
pub fn conversations(token: &auth::Token) -> ConversationTimeline {
    ConversationTimeline::new(token)
}