Neos

Neos

Neos

Constructor

new Neos(optionsopt)

Source:
Creates an instance of the NeosJS Client.
Parameters:
Name Type Attributes Description
options NeosGeneratorOptions <optional>
Properties
Name Type Attributes Default Description
AutoReadMessages boolean <optional>
 true Auto Mark messages as Read in the API when handled by the Neos#messageReceived event
OnlineState OnlineStatus <optional>
 "Online" Online User Status, Displayed in User List.
StatusInterval number <optional>
 60 How Frequent to update the user status. Will trigger Neos#statusUpdated.
NeosVersion string <optional>
 "Neos.js ${PackageVersion}" Defaults to the Library version. Use to display a custom "Neos Version"
CompatabilityHash string <optional>
 "Neos.js ${PackageVersion}" Determines Version Compatability Hash, Used by clients to determing if a session is the same version.
UpdateInterval number <optional>
 1000 Internal Update interval in `ms`. Reccomended: 1000
Update boolean <optional>
 true Enable State of the Internal Update loop. Only reccomend setting this to `false` if you know what you are doing.
MultiMessageDelay number <optional>
 1100 MultiMessage Delay for sending messages in `ms`. Reccomend over `1000ms`

Extends

  • EventEmitter

Members

(static, readonly) CloudX

Source:
Properties:
Name Type Description
Shared Shared
Util Util
CloudX Library, Contains all Classes and Files

(readonly) CurrentSession

Source:
Since:
  • 1.0.0
Get the Current Session

(readonly) CurrentUser

Source:
Get the Current User

(readonly) CurrentUserGroupInfos

Source:
Since:
  • 1.0.0

(readonly) CurrentUserMemberships

Source:
Since:
  • 1.0.0
Get User Memberships

Methods

AddFriend(friend)

Source:
Since:
  • 1.0.0
Send or Accept a friend request - pass the Friend Object
Parameters:
Name Type Description
friend String | Friend
Returns:
void

CountPresentFriends(session) → {Number}

Source:
Since:
  • 1.0.0
Get the number of friends in a Session
Parameters:
Name Type Description
session SessionInfo
Returns:
Friends in Session
Type
Number

FetchRecord(ownerId, recordId)

Source:
Not yet Implimented
Parameters:
Name Type Description
ownerId *
recordId *

FindRecords(record)

Source:
Since:
  • 1.0.0
Not Yet Implimented
Parameters:
Name Type Description
record SearchParameters

GetAllUserMessages() → {List.<Message>}

Source:
Since:
  • 1.0.0
Get all Cached messages
Returns:
Type
List.<Message>

(async) GetCurrencyRates(baseCurrencyopt) → {CurrencyRates}

Source:
Since:
  • 1.0.0
Get currency transaction rates
Parameters:
Name Type Attributes Default Description
baseCurrency string <optional>
 "USD"
Returns:
Type
CurrencyRates

GetFriend(friendId) → {User}

Source:
Since:
  • 1.0.0
get a user from your friend list
Parameters:
Name Type Description
friendId string
Returns:
Type
User

(async) GetFriends(userId) → {List.<Friend>}

Source:
Since:
  • 1.0.0
Get the friends list of a user
Parameters:
Name Type Description
userId string
Returns:
Type
List.<Friend>

(async) GetGroup(groupId) → {Group}

Source:
Since:
  • 1.0.0
Get a Neos Group
Parameters:
Name Type Description
groupId *
Returns:
Type
Group

(async) GetGroupMember(groupId, userId) → {Member}

Source:
Since:
  • 1.0.0
Get a Member from a Group
Parameters:
Name Type Description
groupId String
userId String
Returns:
Type
Member

(async) GetGroupMembers(groupId) → {List.<Member>}

Source:
Since:
  • 1.0.0
Get the Members of a group and their Byte Usage
Parameters:
Name Type Description
groupId String
Returns:
Type
List.<Member>

(async) GetMessageHistory(userId, maxItemsopt) → {List.<Message>}

Source:
Since:
  • 1.0.0
Get History of messages with a user
Parameters:
Name Type Attributes Default Description
userId String
maxItems number <optional>
 100
Returns:
Messages
Type
List.<Message>

(async) GetMessages(fromTimeopt, maxItemsopt, useropt, unreadOnlyopt) → {List.<Message>}

Source:
Since:
  • 1.0.0
Get messages and add them to the cache
Parameters:
Name Type Attributes Default Description
fromTime Date <optional>
 new Date
maxItems Number <optional>
 100
user String <optional>
 null
unreadOnly boolean <optional>
 false
Returns:
Type
List.<Message>

(async) GetRandomExitMessage() → {ExitMessage}

Source:
Since:
  • 1.0.0
Get a random Exit Message
Returns:
Type
ExitMessage

(async) GetStatus(userId) → {UserStatus}

Source:
Since:
  • 1.0.0
Get the status of a user
Parameters:
Name Type Description
userId String
Returns:
UserStatus
Type
UserStatus

(async) GetUser(userId) → {User}

Source:
Since:
  • 1.0.0
Get a specific User by their UserId
Parameters:
Name Type Description
userId string
Returns:
User Object
Type
User

(async) GetUserByName(username) → {User}

Source:
Since:
  • 1.0.0
get a specific User by their username
Parameters:
Name Type Description
username string
Returns:
Type
User

(async) GetUserMessages(UserId) → {UserMessages}

Source:
Since:
  • 1.0.0
Get cached messages with a user
Parameters:
Name Type Description
UserId String
Returns:
Type
UserMessages

(async) GetUsers(username) → {List.<User>}

Source:
Since:
  • 1.0.0
Search neos for username
Parameters:
Name Type Description
username string
Returns:
Type
List.<User>

IgnoreRequest(friend)

Source:
Since:
  • 1.0.0
Ignore a Friend Request - pass the Friend Object
Parameters:
Name Type Description
friend *
Returns:
void

IsFriend(friendId) → {Boolean}

Source:
Since:
  • 1.0.0
Check if a user is friends
Parameters:
Name Type Description
friendId string
Returns:
Type
Boolean

(async) Login(credential, passwordopt, sessionTokenopt, machineId, rememberMeopt, recoverCodeopt) → {Promise.<CloudResult.<UserSession>>}

Source:
Since:
  • 1.0.0
Parameters:
Name Type Attributes Default Description
credential string Email, UserId, or Account Username
password string <optional>
 Not required if sessionToken is set, - Set as new password if recoverCode is set
sessionToken string <optional>
 Session Token to login without storing the password
machineId string Unique Machine ID, If another instance is logged in using the same machine id, the new one will replace the old.
rememberMe boolean <optional>
 false SessionToken will be valid for 7 days
recoverCode string <optional>
 Recovery Code sent via Email, Use to set a new password
Returns:
Type
Promise.<CloudResult.<UserSession>>

Logout(manualopt)

Source:
Since:
  • 1.0.0
Logout
Parameters:
Name Type Attributes Default Description
manual boolean <optional>
 true

MarkMessagesRead(messageIds)

Source:
Since:
  • 1.0.0
Send a Read Reciept, Messages will not show in UnreadMessages query
Parameters:
Name Type Description
messageIds Array.<String> | List.<String> | String
Returns:
*

NeosDBToHttp(neosdb, endpoint) → {String}

Source:
Since:
  • 1.7.1
Example
Neos.GetUser("U-bombitmanbomb").then((User)=>{
	console.log(Neos.NeosDBToHttp(User.Profile.IconUrl))
})
Parameters:
Name Type Description
neosdb String neosdb:///URL
endpoint Number Options: - 0 - Default - 1 - Blob - 2 - CDN - 3 - VideoCDN - null - Default
Returns:
http address to neosdb asset
Type
String

RemoveFriend(friend)

Source:
Since:
  • 1.0.0
Remove a user from your friends list - pass the Friend Object
Parameters:
Name Type Description
friend *
Returns:
void

(async) SendTextMessage(UserId, Message)

Source:
Since:
  • 1.0.0
Send a Text Message. If Message is longer than 128 characters it will be chunked as there is a character limit if a Message element in an Array is longer than 128 characters it will be cut off with "..." by the server
Parameters:
Name Type Description
UserId String Neos User Id to send
Message String | Array.<String> Message or Array of Messages to Send

(async) SendTransaction(UserId, Message) → {Promise.<any>}

Source:
Parameters:
Name Type Description
UserId *
Message *
Returns:
Type
Promise.<any>

UpdateStatus()

Source:
Since:
  • 1.0.0
Update the Neos Account status

Events

debug

Source:
Since:
  • 1.13.0
Console Event
Type:
  • any
Example
Neos.on("debug", (info)=>{console.log(info))})
Parameters:
Name Type Description
info any

error

Source:
Since:
  • 1.0.0
Error Event
Type:
  • Error
Example
Neos.on("error", (err)=>{console.error(err)})
Parameters:
Name Type Description
err Error

friendAdded

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:

friendRemoved

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:

friendRequestCountChanged

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:
  • Number

friendsChanged

Source:
Since:
  • 1.0.0
membershipsUpdated

friendUpdated

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:

groupMemberUpdated

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:
  • Member

groupUpdated

Source:
Since:
  • 1.0.0
membershipsUpdated

login

Source:
Since:
  • 1.0.0
Properties:
Name Type Description
CurrentUser Object Current User
CurrentSession Object Current Session
Login Event
Type:
  • Object
Example
Neos.on("login", ()=>{
	Neos.SendTestMesssage("U-BotOwner", "Bot Online");
...
})

logout

Source:
Since:
  • 1.0.0
Logout Event

membershipsUpdated

Source:
Since:
  • 1.0.0
membershipsUpdated

messageCountChanged

Source:
Since:
  • 1.0.0
membershipsUpdated
Type:
  • Number

messageReceived

Source:
Since:
  • 1.0.0
Message Received
Type:
  • Message
Example
Neos.on("messageReceived", (message)=>{
	switch(message.MessageType){
		case "Text":
			Commands.Run(message)
			break
		default:
		Neos.SendTextMessage(message.SenderId, "I Only can handle Text")
	}
})

sessionChanged

Source:
Since:
  • 1.0.0
Session Changed
Type:
  • UserSession

sessionUpdated

Source:
Since:
  • 1.0.0
Session Updated

userUpdated

Source:
Since:
  • 1.0.0
User Updated
Type: