Amino.Client()

This is a seperated documentation file written for the Amino.Client()

This file might not always be up to date right away
This file contains every Amino.Client() function / method nicely wrapped up
To see the full general documentation consider reading Readme.md (Click here)

Client(string deviceId)

The Amino.Client() Object is a crucial object to make Bots or tools, as there need to be an instance of it to make the library work

Object Values:

Note that some values might be null if you don't login into an Amino account

deviceID : string
sessionID : string
secret : string
userID : string
json : string
googleID : string
appleID : string
facebookID : string
twitterID : string
iconUrl : string
aminoID : string
email : string
phoneNumber : string
nickname : string
is_Global : bool
debug : bool (default: false) : If turned to true, all API responses will be printed into the Trace log

Extras

Consider using try catch statements, if a function fails while executing the request, the response code doesn't indicate success or if a custom condition is triggered, it will throw an Exception!

Required Values:

deviceId : string : if left empty, it will generate a valid Amino Device ID

Example:

Amino.Client client = new Amino.Client(); // This client will be used as an Example Client for the rest of the Amino.Client() docuemntations, whenever "client" is being used, its just an instance of Amino.Client()

Returns:

Nothing

login(string email, string password, string secret)

You can log into an existing Amino account using this function.

Required Values:

email : string : The email of the account
password : string : The password of the account
secret : string (default: null) : The login secret of the account

Example:

try 
{
    client.login("myEmail@Domain.com", "myEpicPassword");
    Console.WriteLine("Logged in!");
} catch 
{
    Console.WriteLine("Could not log into the account!");
}

Returns:

Nothing

logout()

You can log out of an Amino account using this function, make sure you are logged into an account to use this function!

Required Values:

None

Example:

try 
{
    client.logout();
    Console.WriteLine("Logged out!");
} catch 
{
    Console.WriteLine("Could not log out!");
}

Returns:

Nothing

request_verify_code(string email, bool resetPassword)

You can request an Amino verification code using this function.

Required Values:

email : string : The email address for the Amino account
resetPassword : bool (default: false) : This decides if the verification code is supposed to reset the accounts password

Example:

try
{
    client.request_verify_code("myEmail@domain.com", true);
    Console.WriteLine("Requested Verification code!");
} catch
{
    Console.WriteLine("Could not send email");
}

Returns:

Nothing

register(string name, string email, string password, string verificationCode, string deviceId)

This function allows you to register an Amino account

Required Values:

name : string : The name of the account
email : string : The email of the account
password : string : The password of the account
verificationCode : string : The verification code for the email, refer to request_verify_code()
deviceId : string (default: null) : The device ID of the account, if left empty it will generate one for you

Example:

try 
{
    client.register("epicName", "myEmail@Domain.com", "myNicePassword", "ABCDEF");
    Console.WriteLine("Account registered!");
} catch 
{
    Console.Writeline("Could not register account!");
}

Returns:

Nothing

restore_account(string email, string password, string deviceId)

This function allows you to restore a deleted Amino account

Required Values:

email : string : The email of the account you want to restore
password : string : The password of the account you want to restore
deviceId : string (default: null) : The device ID you want to restore the account with, if left empty it will generate one for you

Example:

try 
{
    client.restore_account("myEmail@Domain.com", "myEpicPassword", "someDeviceId");
    Console.WriteLine("Restored account successfully!");
} catch 
{
    Console.WriteLine("Could not restore account!");
}

Returns:

Nothing

delete_account(string password)

This function allows you to delete the current Amino account in use.

Required Values:

password : string : The password of the current Amino Account

Example:

try 
{
    client.delete_account("myEpicPassword");
    Console.WriteLine("Account has been deleted Successfully!");
} catch 
{
    Console.WriteLine("Account could not be deleted!");
}

Returns:

Nothing

activate_account(string email, string verificationCode, string deviceId)

This function allows you to activate an Amino account using a verification Code

Required Values:

email : string : The email address of the account you want to activate
verificationCode : string : The verification Code to activate the account (refer to request_verify_code())
deviceId : string (default: null) : The device ID you want to activate the account from, if left empty it will generate one for you

Example:

try 
{
    client.activate_account("myEmail@Domain.com", "ABCDEF");
    Console.WriteLine("The account has been activated!")
} catch 
{
    Console.WriteLine("Could not activate the account!");
}

Returns:

Nothing

configure_account(Amino.Types.account_gender gender, int age)

This function allows you to configure an Amino accounts age and gender

Required Values:

gender : Amino.Types.account_gender : The gender you want the account to be configured to
age : int : Sets the age of the account : This value cannot be lower than 13!

Example:

try 
{
    client.configure_account(Amino.Types.account_gender.Non_Binary, 18);
    Console.WriteLine("Configured account successfully!");
} catch 
{
    Console.WriteLine("Could not configure account!");
}

Returns:

Nothing

change_password(string email, string password, string verificationCode)

This function allows you to change the password of the current Amino account.

Required Values:

email : string : The email of your account
password : string : The new password you want the account to change to
verificationCode : string : The verification code needed to reset your Password (refer to request_verify_code())

Example:

try 
{
    client.change_password("myEmail@Domain.com", "myNewPassword", "ABCDEF");
    Console.WriteLine("Account password has been changed successfully!");
} catch 
{
    Console.WriteLine("Could not reset password!");
}

Returns:

Nothing

get_user_info(string userId)

This function allows you to get information about a global Amino Profile

Required Values:

userId : string : The object / user ID of the Amino user you want to get information about

Example:

try 
{
    var userProfile = client.get_user_info("anyUserId");
    Console.WriteLine("Account username: " + userProfile.nickname);
} catch 
{
    Console.WriteLine("Could not get user information");
}

Returns:

Amino.Objects.GlobalProfile

check_device(string deviceId)

This function allows you to check if a device ID is valid or not

Required Values:

deviceId : string : The device ID you want to check

Example:

try 
{
    if(client.check_device("someDeviceId")) 
    {
        Console.WriteLine("This device ID is valid!");
    } else 
    {
        Console.WriteLine("This device ID is invalid!");
    }
} catch 
{
    Console.WriteLine("Could not check device ID");
}

Returns:

bool

get_event_log()

This function allows you to get information about the current accounts event log!

Required Values:

None

Example:

try 
{
    var eventLog = client.get_event_log();
    Console.WriteLine("EventLog JSON: " + eventLog.json);
} catch 
{
    Console.WriteLine("Could not get eventLog!");
}

Returns:

Amino.Objects.EventLog

get_subClient_communities(int start, int size)

This function allows you to get information about all the Communities where the current Amino account is in

Required Values:

start : int (default: 0) : The start index for getting the communities
size : int (default: 25) : Sets the range between start and whatever number this is set to

Example:

try 
{
    List<Amino.Objects.Community> communityList = client.get_subClient_communities();
    Console.WriteLine("First community Name: " + communityList[0].communityName);
} catch 
{
    Console.WriteLine("Could not get subClient communities.");
}

Returns:

List<Amino.Objects.Community>

get_subClient_profiles(int start, int size)

This function allows you to get information about all the community profiles where the current Amino account is in

Required Values:

start : int (default: 0) : The start index of the Community profiles
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.CommunityProfile> profileList = client.get_subClient_profiles();
    Console.WriteLine("Profile name in first community: " + profileList[0].nickname);
} catch 
{
    Console.WriteLine("Could not get subClient profiles");
}

Returns:

List<Amino.Objects.CommunityProfile>

get_account_info()

This function allows you to get information about the current Amino account

Required Values:

None

Example:

try 
{
    var accountInfo = client.get_account_info();
    Console.WriteLine("Account was created on " + accountInfo.createdTime);
} catch 
{
    Console.WriteLine("Could not get user information");
}

Returns:

Amino.Objects.UserAccount

get_chat_threads(int start, int size)

This function allows you to get all chat threads where the current Amino account is in

Required Values:

start : int (default: 0) : Sets the Start index for getting chat list
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

{
    List<Amino.Objects.Chat> chatList = client.get_chat_threads();
    Console.WriteLine("Nickname of the owner of the first chat: " + chatList[0].Author.nickname);
} catch 
{
    Console.WriteLine("Could not get chats!");
}

Returns:

List<Amino.Objects.Chat>

get_chat_thread(string chatId)

This function allows you to get information about a specific chat thread where the current Amino account is in

Required Values:

chatId : string : The object / chat ID of the chat thread you want the information from

Example:

try 
{
    var Chat = client.get_chat_thread("myChatId");
    Console.WriteLine("Chat Member Count: " + Chat.membersCount);
} catch 
{
    Console.WriteLine("Could not get chat Thread");
}

Returns:

Amino.Objects.Chat

get_chat_users(string chatId, int start, int size)

This function allows you to get chat member information about a specific chat thread

Required Values:

chatId : string : The object / chat ID of the chat thread
start : int (default: 0) : Sets the Start index for getting chat users
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.ChatMember> chatMemberList = client.get_chat_users("myChatId");
    Console.WriteLine("Name of the first chat member: " + chatMemberList[0].nickname);
} catch 
{
    Console.WriteLine("Could not get chat users");
}

Returns:

List<Amino.Objects.ChatMember>

join_chat(string chatId)

This function allows you to join a chat thread using the current Amino account.

Required Values:

chatId : string : The object / chat ID of the chat thread you want to join

Example:

try 
{
    client.join_chat("myChatId");
    Console.WriteLine("Joined chat");
} catch 
{
    Console.WriteLine("Could not join chat!");
}

Returns:

None

leave_chat(string chatId)

This function allows you to leave a chat thread using the current Amino account.

Required Values:

chatId : string : The object / chat ID of the chat thread you want to leave

Example:

try 
{
    client.leave_chat("myChatId");
    Console.WriteLine("Left chat");
} catch 
{
    Console.WriteLine("Could not leave chat!");
}

Returns:

Nothing

invite_to_chat(stiring[] userIds, string chatId)

This function allows you to invite one or more members to a chat thread with the current Amino account

Required Values:

Example:

try 
{
    string[] users = new string[] { "userId_1", "userId_2" };
    client.invite_to_chat(users, "chatId");
    Console.WriteLine("Invited users!");
} catch 
{
    Console.WriteLine("Could not invite members to chat");
}

Returns:

Nothing

kick_from_chat(string userId, string chatId, bool allowRejoin)

This function allows you to kick a user from a chat thread

Required Values:

userId : string : The userId of the user you want to kick
chatId : string : The object / chat ID of the chat thread you want to kick the user from
allowRejoin : bool (default: true) : Decides if the user is allowed to rejoin the chat thread or not

Example:

try 
{
    client.kick_from_chat("userId", "chatId", false);
    Console.WriteLine("User has been kicked from chat!");
} catch 
{
    Console.WriteLine("Could not kick member from chat!");
}

Returns:

Nothing

get_chat_messages(string chatId, int size, string pageToken)

This function allows you to get a collection of messages in a specific chat thread the current Amino account is in

Required Values:

chatId : string : The object / chat ID of the chat thread that you want the messages from
size : int (default: 25) : The amount of messages you want to get
pageToken : string (default: null) : The page Token of the messages

Example:

try 
{
    List<Amino.Obejcts.MessageCollection> messageList = client.get_chat_messages("someChatId", 50);
    Console.WriteLine("Nickname of the author of the first message: " + messageList[0].Author.nickname);
} catch 
{
    Console.WriteLine("Could not get chat messages!");
}

Returns:

List<Amino.Objects.MessageCollection>

search_community(string aminoId)

This function allows you to search for a Community by its aminoId (**not** and ObjectId) and retrieve information about it

Required Values:

aminoId : string : The aminoId that you want to look up

Example:

try 
{
    List<Amino.Objects.CommunityInfo> communityInfo = client.search_community("myLookupTerm");
    Console.WriteLine("Name of the first community result: " + communityInfo[0].name);
} catch 
{
    Console.WriteLine("Could not search for community");
}

Returns:

Amino.Objects.CommunityInfo

get_user_following(string userId, int start, int size)

Required Values:

userId : string : The object / user Id of a target user
start : int (default: 0) : Sets the Start index for getting user followings
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.UserFollowings> userFollowings = client.get_user_followings("someUserId");
    Console.WriteLine("Name of the first user following: " + userFollowings[0].nickname);
} catch 
{
    Console.WriteLine("Could not get user followings");
}

Returns:

List<Amino.Objects.UserFollowings>

get_user_followers(string userId, int start, int size)

This function allows you to get a list of users that follow a user

Required Values:

userId : string : The object / user ID of the user you want to get the followers of
start : int (default: 0) : Sets the Start index for getting user followers
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.UserFollowings> userFollowers = client.get_user_followers("someUserId");
    Console.WriteLine("Name of the first follower: " + userFollowers[0].nickname);
} catch 
{
    Console.WriteLine("Could not get user followers");
}

Returns:

List<Amino.Objects.UserFollowings>

get_user_visitors(string userId, int start, int size)

This function allows you to get a list of users that have visited a target profile

Required Values:

userId : string : The target users object / user ID that you want to get the visitors of
start : int (default: 0) : Sets the Start index for getting user visitors
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.UserVisitor> userVisitors = client.get_user_visitors("someUserId");
    Console.WriteLine("Name list of all visitors:");
    foreach(Amino.Objects.UserVisitor visitor in userVisitors)
    {
        Console.WriteLine(visitor.Profile.nickname);
    }

} catch 
{
    Console.WriteLine("Could not get user visitors!");
}

Returns:

List<Amino.Objects.UserVisitor>

get_blocked_users(int start, int size)

This function allows you to get a list of users that the current Amino account has blocked

Required Values:

start : int (default: 0) : Sets the Start index for getting blocked users
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.BlockedUser> blockedUsers = client.get_blocked_users();
    Console.WriteLine("List of blocked users (user IDs)");
    foreach(Amino.Obejcts.BlockedUser user in blockedUsers) 
    {
        Console.WriteLine(user.userId);
    }
} catch 
{
    Console.WriteLine("Could not get blocked users");
}

Returns:

List<Amino.Objects.BlockedUser>

get_blocker_users(int start, int size)

This function allows you to get a list of user IDs of the users who have currenty blocked the current Amino account

Required Values:

start : int (default: 0) : Sets the Start index for getting blocker users
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<string> blockerUsers = client.get_blocker_users();
    if(blockerUsers.Count > 0) 
    {
        Console.WriteLine("First blocker user: " + blockerUsers[0]);
    }
} catch 
{
    Console.WriteLine("Could not get blocker users");
}

Returns:

List<string>

get_wall_comments(string userId, Amino.Types.Sorting_Types type, int start, int size)

This function allows you to get a list of comments that have been left on a users wall

Required Values:

userId : string : The object / user ID of the user you want to get the wall comments from
type : Amino.Types.Sorting_Types : The type of sorting you want to apply to the comment filter
start : int (default: 0) : Sets the Start index for getting wall comments
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Obejcts.Comment> wallComments = client.get_wall_comments("someUserId", Types.Sorting_Types.Newest);
    Console.WriteLine("First wall comment content: " + wallComments[0].content);
} catch 
{
    Console.WriteLine("Could not get wall comments");
}

Returns:

List<Amino.Objects.Comment>

flag(string reason, Amino.Types.Flag_Types flagType, Amino.Types.Flag_Targets targetType, string targetId, bool asGuest)

This function allows you to flag a post / profile on Amino

Required Values:

reason : string : The reason you are flagging the target
flagType : Amino.Types.Flag_Types : The type of flagging that is being done
targetType : Amino.Types.Flag_Targets : The type of the target that is being flagged
targetId : string : The object / user ID of the target that you want to flag
asGuest : bool : This value decides if you want to flag the content as a guest or as a logged in Amino user

Example:

try 
{
    client.flag("spamming posts", Amino.Types.Flag_Types.Spam, Amino.Types.Flag_Targets.User, false);
    Console.WriteLine("Flagged content!");
} catch 
{
    Console.WriteLine("Could not flag content");
}

Returns:

Nothing

delete_message(string chatId, string messageId, bool asStaff, string reason)

This function allows you to delete a specific chat message using the current Amino account

Required Values:

chatId : string : The object / chat ID where the message has been sent in
messageId : string : The object / message ID of the message that you want to delete
asStaff : bool (default: false) : This value decides if you're deleting the message as a staff membber
reason : string (default: null) : The reason provided if the message is being deleted as a staff member

Example:

try 
{
    client.delete_message("someChatId", "someMessageId", true, "spam content");
    Console.WriteLine("Message deleted!");
} catch 
{
    Console.WriteLine("Could not delete message!");
}

Returns:

Nothing

mark_as_read(string chatId, string messageId)

This function allows you to mark a message as read

Required Values:

chatId : string : The object / chat ID of the chat where the message has been sent in
messageId : string : The object / message ID that you want to mark as read

Example:

try 
{
    client.mark_as_read("someChatId", "someMessageId");
    Console.WriteLine("Marked message as read");
} catch 
{
    Console.WriteLine("Could not mark message as read");
}

Returns:

Nothing

visit(string userId)

This function allows you to visit a users Amino profile

Required Values:

userId : string : The object / user ID of the user that you want to visit

Example:

try 
{
    client.visit("someUserId");
    Console.WriteLine("Visited profile");
} catch 
{
    Console.WriteLine("Could not visit user!");
}

Returns:

Nothing

follow_user(string userId)

This function allows you to follow a user using the current Amino account

Required Values:

userId : string : The object / user ID of the user you want to follow

Example:

try 
{
    client.follow("someUserId");
    Console.WriteLine("Followed user");
} catch 
{
    Console.WriteLine("Could not follow user");
}

Returns:

Nothing

unfollow_user(string userId)

This function allows you to unfollow a user using the current Amino account

Required Values:

userId : string : The object / user ID of the user you want to unfollow

Example:

try 
{
    client.unfollow_user("someUserId");
    Console.WriteLine("Unfollowed user");
} catch 
{
    Console.WriteLine("Could not unfollow user");
}

Returns:

Nothing

block_user(string userId)

This function allows you to block a user using the current Amino account

Required Values:

userId : string : The object / user ID of the user you want to block

Example:

try 
{
    client.block_user("someUserId");
    Console.WriteLine("Blocked user");
} catch 
{
    Console.WriteLine("Could not block user");
}

Returns:

Nothing

unblock_user(string userId)

This function allows you to unblock a user using the current Amino account

Required Values:

userId : string : The object / user ID of the user you want to unblock

Example:

try 
{
    client.unblock_user("someUserId");
    Console.WriteLine("Unblocked user");
} catch 
{
    Console.WriteLine("Could not unblock user");
}

Returns:

Nothing

join_community(string communityId, string invitationCode)

This function allows you to join a community using the current Amino account

Required Values:

communityId : string : The ID of the community that you want to join
invitationCode : string (default: null) : The invitation code of the community (if there is one)

Example:

try 
{
    client.join_community("123456");
    Console.WriteLine("Joined community");
} catch 
{
    Console.WriteLine("Could not join community");
}

Returns:

Nothing

join_community_request(string communityId, string message)

This function allows you to make a join request to a community

Required Values:

communityId : string : The community ID of the community that you want to request to join in
message : string (default: null) : The message you want to state as reason on why you want to join

Example:

try 
{
    client.join_community_request("123456", "I like foxes.");
    Console.WriteLine("Requested to join community");
} catch 
{
    Console.WriteLine("Could not request to join the community");
}

Returns:

Nothing

leave_community(string communityId)

This function allows you to leave a comunity using the current Amino account

Required Values:

communityId : string : The community ID of the community that you want to leave

Example:

try 
{
    client.leave_community("123456");
    Console.WriteLine("Left community");
} catch 
{
    Console.WriteLine("Could not leave community");
}

Returns:

Nothing

flag_community(string communityId, string reason, Amino.Types.Flag_Types flagType, bool asGuest)

This function allows you to flag a community

Required Values:

communityId : string : The community ID of the community you want to flag
reason : string : The reason why you want to flag the community
flagType : Amino.Types.Flag_Types : The Type of flagging you want to do
asGuest : bool (default: false) : This value decides if you want to flag the community as a guest or with an Amino account

Example:

try 
{
    client.flag_community("123456", "No foxes", Amino.Types.Flag_Types.Trolling, true);
    Console.WriteLine("Flagged community");
} catch 
{
    Console.WriteLine("Could not flag community");
}

Returns:

Nothing

upload_media(byte[] file | string filePath, Amino.Types.Upload_File_Types type)

This function allows you to upload media directly to the Amino servers, it will return the resulting media URL.

Required Values:

file : byte[] : The bytes of the file that you want to upload
filePath : string : The path to the file that you want to upload
type : Amino.Types.Upload_File_Types : The type of media that you want to upload

Example:

try 
{
    //Uploading media using the file bytes
    byte[] fileBytes = File.ReadAllBytes("Path_To_File");
    string uploaded_with_bytes = client.upload_media(fileBytes, Types.upload_File_Types.Image);

    //Uploading media using file path
    string uploaded_with_path = client.upload_media("Path_To_File", Types.upload_File_Types.Image);

} catch 
{
    Console.WriteLine("Could not upload media");
}

Returns:

string

edit_profile(string nickname, string content, byte[] icon, string backgroundColor, string backgroundMediaUrl, string defaultChatbubbleId)

This function allows you to edit your global Amino profile

Required Values:

nickname : string (default: null) : The nickname you want the account to have
content : string (default: null) : The content of the accounts description you want the account to have
icon : byte[] (default: null) : The icon you want the account to have as profile picture
backgroundColor : string (default: null) : The background color of the account as HEX format
backgroundMediaUrl : string (default: null) : The backkground media you want the account to have
defaultChatbubbleId : string (default: null) : The default chat bubble ID you want the account to have

Example:

try 
{
    client.edit_profile("I hated making this one.", "it sucked and probably doesn't even work.", backgroundColor: "#FFFFFF");
    Console.WriteLine("Edited profile");
} catch 
{
    Console.WriteLine("Could not edit profile");
}

Returns:

Nothing

set_privacy_status(bool isAnonymous, bool getNotifications)

This function allows you to set the privacy status of the current Amino account

Required Values:

isAnonymous : bool (default: false) : Decides if the account is anonymous
getNotifications : bool (default: true) : Decides if you get notifications or not

Example:

try 
{
    client.set_privacy_status(true, false);
    Console.WriteLine("Set privacy status");
} catch 
{
    Console.WriteLine("Could not set privacy status");
}

Returns:

Nothing

set_amino_id(string aminoId)

This function allows you to change your Amino ID, note that you can't do this an unlimited amount of times

Required Values:

aminoId : string : The Amino ID that you want to assign for the account

Example:

try 
{
    client.set_amino_id("someAminoID");
    Console.WriteLine("Set Amino ID");
} catch 
{
    Console.WriteLine("Could not set Amino ID");
}

Returns:

Nothing

add_linked_community(int communityId)

This function allows you to add a linked community to the profile of the current Amino account

Required Values:

communityId : int : The ID of the community that you want to add

Example:

try 
{
    client.add_linked_community(123456);
    Console.WriteLine("Added linked community");
} catch 
{
    Console.WriteLine("Could not add linked community");
}

Returns:

Nothing

remove_linked_community(int communityId)

This function allows you to remove a linked community from the profile of the current Amino account

Required Values:

communityId : int : The ID of the community that you want to remove

Example:

try 
{
    client.remove_linked_community(123456);
    Console.WriteLine("Removed linked community");
} catch 
{
    Console.WriteLine("Could not remove linked community");
}

Returns:

Nothing

comment(string message, Amino.Types.Comment_Types type, objectId)

This function allows you to comment below a post, a wall or reply to a comment using the current Amino account

Required Values:

message : string : The content of the comment that you want to post
type : Amino.Types.Comment_Types : The type of comment you want to post
objectId : string : The object ID of the target you want to comment under / reply to

Example:

try 
{
    client.comment("Nice post. Sadly it's not about Foxes.", Amino.Types.Comment_Types.Blog, "somePostId");
    Console.WriteLine("Comment posted");
} catch 
{
    Console.WriteLine("Could not comment");
}

Returns:

Nothing

delete_comment(string commentId, Amino.Types.Comment_Types type, string objectId)

This function allows you to delete a comment from a post, a users wall or a reply using the current Amino account

Required Values:

commentId : string : The object ID of the comment that you want to delete
type : Amino.Types.Comment_Types : The type of comment you're targetting
objectId : string : The object ID where the target comment has been commented on

Example:

try 
{
    client.delete_comment("someCommentId", Amino.Types.Comment_Types.Blog, "someBlogPostId");
    Console.WriteLine("Deleted comment");
} catch 
{
    Console.WriteLine("Could not delete comment");
}

Returns:

Nothing

like_post(string objectId, Amino.Types.Post_Types type)

This function allows you to like a post using the current Amino account

Required Values:

objectId : string : The ID of the post you want to like
type : Amino.Types.Post_Types : The type of post that you want to like

Example:

try 
{
    client.like_post("somePostID", Amino.Types.Post_Types.Blog);
    Console.WriteLine("Liked post");
} catch 
{
    Console.WriteLiine("Could not like post");
}

Returns:

Nothing

unlike_post(string objectId, Amino.Types.Post_Types type)

This function allows you to unlike a post using the current Amino account

Required Values:

objectId : string : The object ID of the post that you want to unlike
type : Amino.Types.Post_Types : The type of post that you want to unlike

Example:

try 
{
    client.unlike_post("somePostId", Amino.Types.Post_Types.Blog);
    Console.WriteLine("Unlikes post");
} catch 
{
    Console.WriteLine("Could not unlike post");
}

Returns:

Nothing

get_membership_info()

This function allows you to get information about the current Amino accounts Amino+ membership

Required Values:

None

Example:

try 
{
    var membershipInfo = client.get_membership_info();
    Console.WriteLine("The membership will expire on: " + membershipInfo.Membership.expiredTime);
} catch 
{
    Console.WriteLine("Could not get membership info");
}

Returns:

Amino.Objects.MembershipInfo

get_ta_announcements(Amino.Types.Supported_Languages language, int start, int size)

This function allows you to get a list of Team Amino announcements

Required Values:

language : Amino.Types.Supported_Languages (default: Amino.Types.Supportedd_Languages.english)
start : int (default: 0) : Sets the Start index for getting the announcement posts
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.Post> announcementList = client.get_ta_announcements();
    Console.WriteLine("Title of the first post: " + announcementList[0].title);
} catch 
{
    Console.WriteLine("Could not get Team Amino announcement posts!");
}

Returns:

Amino.Objects.Post

get_wallet_info()

This function allows you to get the wallet info of the current Amino account

Required Values:

None

Example:

try 
{
    var walletInfo = client.get_wallet_info();
    Console.WriteLine("This account has " + walletInfo.totalCoins + " Amino coins");
} catch 
{
    Console.WriteLine("Could not get wallet info");
}

Returns:

Amino.Objects.WalletInfo

get_wallet_history(int start, int size)

This function allows you to get the wallet history of the current Amino account

Required Values:

start : int (default: 0) : Sets the Start index for getting the wallet history
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.CoinHistoryEntry> coinHistory = client.get_wallet_history();
    Console.WriteLine("Latest transaction amount: " + coinHistory[0].changedCoins + " paid by " + coinHistory[0].userId);
} catch 
{
    Console.WriteLine("Could not get wallet history.");
}

Returns:

List<Amino.Objects.CoinHistoryEntry>

get_from_deviceId(string deviceId)

This function allows you to get a user ID thats linked to a deviceId

Required Values:

deviceId : string : The device ID that you want to get the userId from

Example:

try 
{
    Console.WriteLine("Some stuff: " + client.get_from_deviceId("someDeviceId"));
} catch 
{
    Console.WriteLine("Could not get data from userId");
}

Returns:

string

get_from_code(string aminoUrl)

This function allows you to get information about a specific Amino URL (code)

Required Values:

aminoUrl : string : The URL of the object that you want to get information about

Example:

try 
{
    var objectInfo = client.get_from_code("someUrl");
    Console.WriteLine("Target Code: " + objectInfo.targetCode);
} catch 
{
    Console.WriteLine("Could not get object information");
}

Returns:

Amino.Objects.FromCode

get_from_id(string objectId, Amino.Types.Object_Types type, string communityId)

This function allows you to get informations abou tan object using the object ID

Required Values:

objectId : string : The ID of the object that you want to get information of
type : Amino.Objects.Object_Types : The type of the obejct that you want to get information of
communityId : string (default: null) : If you want to get information about an object inside of a community you can assign a CommunityId to this function

Example:

try 
{
    var objectInfo = client.get_from_id("somePostId", Amino.Types.Object_Types.Blog, "123456");
    Console.WriteLine("Path of the object: " + objectInfo.path);
} catch 
{
    Console.WriteLine("Could not get object informations");
}

Returns:

Amino.Objects.FromId

get_supported_languages()

This function allows you to get the language codes for each supported language as a strin array

Required Values:

None

Example:

try 
{
    string[] supportedLanguages = client.get_supported_languages();
    Conmsole.WriteLine("List of supported languages:");
    foreach(string language in supportedLanguages) 
    {
        Console.WriteLine(language);
    }
} catch 
{
    Console.WriteLine("Could not get supported languages");
}

Returns:

string[]

claim_new_user_coupon()

This function allows you to claim the new user coupon for the current Amino account

Required Values:

None

Example:

try 
{
    client.claim_new_user_coupon();
    Console.WriteLine("Claimed new user coupon");
} catch 
{
    Console.WriteLine("Could not claim new user coupon");
}

Returns:

Nothing

get_all_users(int start, int size)

This function allows you to get a list of all global Amino users

Required Values:

start : int (default: 0) : Sets the Start index for getting user profiles
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Obejcts.UserProfile> users = client.get_all_users();
    Console.WriteLine("List of user info:")
    foreach(Amino.Objects.UserProfile user in users) 
    {
        Console.WriteLine("Name: " + user.nickname.PadRight(16) + " userId: " + user.userId);
    }
} catch 
{
    Console.WriteLine("Could not get users!");
}

Returns:

List<Amino.Obejcts.UserProfile>

accept_host(string chatId, string requestId)

This function allows you to accept host / organizer of a chat room using the current Amino account

Required Values:

chatId : string : The object / chat ID of the chat where you have been requested to be host in
requestId : string : The object ID of the chat host request

Example:

try 
{
    client.accept_host("someChatId", "someRequestId");
    Console.WriteLine("Chat host has been accepted");
} catch 
{
    Console.WriteLine("Could not accept chat host");
}

Returns:

Nothing

accept_organizer(string chatId, string requestId)

Refer to `accept_host`.

link_identify(string inviteCode)

This function allows you to get information about an Amino invite code and its community

Required Values:

inviteCode : string : The Amino invite code you want to get information from (The inviteCode is not the full invite URL)

Example:

try 
{
    var inviteInformation = client.link_identify("ABCDEF")M;
    Console.WriteLine("InviteId: " + inviteInformation.invitationId + " for community: " + inviteInformation.Community.name);
} catch 
{
    Console.WriteLine("Could not get invite information!");
}

Returns:

Amino.Obejcts.FromInvite

wallet_config(Amino.Types.Wallet_Config_Levels walletLevel)

This function allows you to set the coin wallet configuration using the current Amino account

Required Values:

walletLevel : Amino.Types.Wallet_Config_Levels : The wallet Level that you want to set

Example:

try 
{
    client.wallet_config(Amino.Types.Wallet_Config_Levels.lvl_2);
    Console.WriteLine("Set wallet level successfully");
} catch 
{
    Console.WriteLine("Could not set wallet level");
}

Returns:

Nothing

get_avatar_frames(int start, int size)

This function allows you to get a list of Avatar Frames that the current Amino account has unlocked

Required Values:

start : int (default: 0) : Sets the Start index for getting the Avatar Frames
size : int (default: 25) : Sets the range between start and whatever this is set to

Example:

try 
{
    List<Amino.Objects.AvatarFrame> frames = client.get_avatar_frames();
    if(frames.Count > 0) 
    {
        Console.WriteLine("All Frame IDs and Names in current list:");
        foreach(Amino.Obejcts.AvatarFrame frame in frames) 
        {
            Console.WriteLine("FrameID: " + frame.frameId + " FrameName: " + frame.name);
        }
    } else 
    {
        Console.WriteLine("This account does not have any Avatar Frames!");
    }
} catch 
{
    Console.WriteLine("Could not get Avatar Frames");
}

Files

Client.md

Latest commit

History

Client.md

File metadata and controls

Amino.Client()

This is a seperated documentation file written for the Amino.Client()

Object Values:

Extras

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values:

Example:

Returns:

Required Values: