capacitor_bindings 0.14.0

Capacitor bindings to help you build android and ios apps with rust.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

#[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
use crate::{extern_functions::*, prelude::*};
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;

/// For details, https://github.com/openforge/capacitor-game-connect
pub struct GameConnect {}

impl GameConnect {
    /// Method to sign-in a user.
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn sign_in() -> Result<PlayerSignIn, Error> {
        run_unit_value(game_connect_sign_in).await
    }

    /// Method to display the Achievements view
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn show_achievements() -> Result<(), Error> {
        run_unit_unit(game_connect_show_achievements).await
    }

    /// Method to display the Leaderboards
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn show_leaderboard(options: impl Into<ShowLeaderboardOptions>) -> Result<(), Error> {
        run_value_unit(options, game_connect_show_leaderboard).await
    }

    /// Method to submit a score to the Google Play Services SDK or IOS Leaderboards
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn submit_score(options: impl Into<SubmitScoreOptions>) -> Result<(), Error> {
        run_value_unit(options, game_connect_submit_score).await
    }

    /// Method to unlock an achievement
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn unlock_achievement(
        options: impl Into<UnlockAchievementOptions>,
    ) -> Result<(), Error> {
        run_value_unit(options, game_connect_unlock_achievement).await
    }

    /// Method to increment the progress of an achievement
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn increment_achievement_progress(
        options: impl Into<IncrementAchievementOptions>,
    ) -> Result<(), Error> {
        run_value_unit(options, game_connect_increment_achievement_progress).await
    }

    /// Method to get total player score from a leaderboard
    #[cfg(all(feature = "game_plugin", any(feature = "ios", feature = "android")))]
    pub async fn get_user_total_score(
        options: impl Into<UserScoreOptions>,
    ) -> Result<PlayerScore, Error> {
        run_value_value(options, game_connect_get_user_total_score).await
    }
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct ShowLeaderboardOptions {
    #[builder(setter(into))]
    #[serde(rename = "leaderboardID")]
    pub leaderboard_id: String,
}

impl From<&str> for ShowLeaderboardOptions {
    fn from(value: &str) -> Self {
        ShowLeaderboardOptions {
            leaderboard_id: value.to_string(),
        }
    }
}

impl From<String> for ShowLeaderboardOptions {
    fn from(leaderboard_id: String) -> Self {
        ShowLeaderboardOptions { leaderboard_id }
    }
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct SubmitScoreOptions {
    #[builder(setter(into))]
    #[serde(rename = "leaderboardID")]
    pub leaderboard_id: String,

    /// If your leaderboard has decimal places, this will be the amount with the decimal point removed.
    /// For example, if your leaderboard shows two decimal places and you want to submit 123.45, this number should be 12345.
    #[serde(rename = "totalScoreAmount")]
    pub total_score_amount: i32,
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct UnlockAchievementOptions {
    #[builder(setter(into))]
    #[serde(rename = "achievementID")]
    pub achievement_id: String,
}

impl From<&str> for UnlockAchievementOptions {
    fn from(value: &str) -> Self {
        UnlockAchievementOptions {
            achievement_id: value.to_string(),
        }
    }
}

impl From<String> for UnlockAchievementOptions {
    fn from(achievement_id: String) -> Self {
        UnlockAchievementOptions { achievement_id }
    }
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct IncrementAchievementOptions {
    #[builder(setter(into))]
    #[serde(rename = "achievementID")]
    pub achievement_id: String,

    #[serde(rename = "pointsToIncrement")]
    pub points_to_increment: i32,
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct PlayerSignIn {
    #[builder(setter(into))]
    #[serde(rename = "player_name")]
    pub player_name: String,

    #[builder(setter(into))]
    #[serde(rename = "player_id")]
    pub player_id: String,
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct UserScoreOptions {
    #[builder(setter(into))]
    #[serde(rename = "leaderboardID")]
    pub leaderboard_id: String,
}

impl From<&str> for UserScoreOptions {
    fn from(value: &str) -> Self {
        UserScoreOptions {
            leaderboard_id: value.to_string(),
        }
    }
}

impl From<String> for UserScoreOptions {
    fn from(leaderboard_id: String) -> Self {
        UserScoreOptions { leaderboard_id }
    }
}

#[derive(Clone, Default, Debug, Serialize, Deserialize, TypedBuilder)]
#[serde(default)]
pub struct PlayerScore{
    #[builder(setter(into))]
    #[serde(rename = "player_score")]
    pub player_score: i32
}