Page not found :(
-The requested page could not be found.
-amino.js is a library for Narvii’s Amino app, an application for communities.
- -It is intuitive and easy to use. And because it is a simple JavaScript library, it can be used almost anywhere - from your Discord bot to your website.
- -View the repository on GitHub here.
- -subscribe via RSS
Page not found :(
-The requested page could not be found.
-Loads messages from a chat.
- -| Name | -Type | -Description | -
|---|---|---|
sid |
- SecurityString | -For authenticating with the Narvii-API. | -
com |
- CommunityUUID | -The Community ID that can be obtained by the function getJoinedComs | -
uid |
- ChatUUID | -The Chats ID that can be obtained by the function getJoinedChats | -
count |
- Number | -The amount of Messages to Load (defaults to 1); | -
Returns: -Array of message objects.
- -Example of message object:
- -msgList[0] = {
- 'threadId': uid,
- 'messageId': element.messageId,
- 'msg': element.content,
- 'type': element.type,
- 'author': {
- 'uid': element.author.uid,
- 'name': element.author.nickname,
- 'level': element.author.level,
- 'role': element.author.role
- }
-}Access using getChat().messages
Load information about chats the user is in.
- -| Name | -Type | -Description | -
|---|---|---|
sid |
- SecurityString | -For authenticating with the Narvii-API. | -
com |
- CommunityUUID | -A ID that can be obtained by the function getJoinedComs | -
Returns: An array of chat objects.
- -threads[0] = {
- 'threadId': '<A Random UUID>',
- 'memberCount': 59,
- 'title': 'Laberchat für alle',
- 'joined': true,
- 'public': false,
- 'group': true,
- 'muted': false,
- 'unread': true,
- 'lastMessage': {
- 'senderId': 'A UserID',
- 'message': 'The Last Message sent to the Channel'
- },
- 'members': 'still Raw JSON from the API!'
-}Get a JSON object of all the communities you are in, and their information.
- -| Name | -Type | -Description | -
|---|---|---|
sid |
- SecurityString | -For authenticating with the Narvii-API. | -
Returns: Array of community objects.
- -coms[0] = {
- "id": "x159192087",
- "name": "German Roleplay Community",
- "url": "https://aminoapps.com/c/german-roleplay-community/"
-}Get a simplefied JSON object of your profile in Amino.
- -| Name | -Type | -Description | -
|---|---|---|
sid |
- SecurityString | -For authenticating with the Narvii-API. | -
Returns: Your profile in a JSON response.
- -Note: mediaList is taken straight from the API.
- -{
- account: {
- uid: '516e2361-f357-4cac-a531-07e4c8924064',
- username: 'Lelouch',
- mediaList: [
- [100,
- 'http://pm1.narvii.com/6781/7d586df7ad9d181b7a2ef219f98a15c765c9e080v2_00.jpg',
- null
- ]
- ],
- icon: 'http://pm1.narvii.com/6759/0b6a0092b6d860fb664c199ad8f791ad3f764b95v2_00.jpg'
- },
- status: 'ok',
- error: null
-}Get a security string for access to the API.
- -| Name | -Type | -Description | -
|---|---|---|
email |
- String | -Email associated with Amino account. | -
password |
- String | -Password to Amino account. | -
deviceID |
- UUID | -An optional device ID, defaults to ours. Go here to find out how to use your own, or use ours. | -
Returns: Security ID (sid) to be used with other functions.
- -Send a message in a chat.
- -| Name | -Type | -Description | -
|---|---|---|
sid |
- SecurityString | -For authenticating with the Narvii-API. | -
com |
- CommunityUUID | -The Community ID that can be Obtained by getJoinedComs() |
-
uid |
- ChatUUID | -The chat ID returned by getJoinedChats |
-
msg |
- String | -The message to be sent. | -
Returns: Confirmation JSON that the message was sent.
- -Example of a successful send.
- -message = {
- message: {
- message: "Hello, squad!",
- threadID: "<chat room>",
- sent: true
- },
-
- status: "ok",
- error: null
-}