JSDoc: Class: InstantiatedSDK

Constructor

new InstantiatedSDK()

Source:

instantiated.js, line 5

Methods

AboutInstantiated()

Displays the about section of Instantiated.

Source:

instantiated.js, line 1187

AccountAssignRole(Username, RoleName)

Assigns the account a role specified by the host.

Parameters:

Name	Type	Description
`Username`	String
`RoleName`	String

Source:

instantiated.js, line 526

AccountChangePassword(NewPassword, Username)

Changes the account's password.

Parameters:

Name	Type	Default	Description
`NewPassword`	String
`Username`	String	null

Source:

instantiated.js, line 496

AccountDelete(Username)

Deletes the account. Username left blank will delete your account.

Parameters:

Name	Type	Default	Description
`Username`	String	null

Source:

instantiated.js, line 511

AccountDeleteData(Item)

Deletes the item from your personal account.

Parameters:

Name	Type	Description
`Item`	String

Source:

instantiated.js, line 381

AccountDeleteMessage(Position, Username)

Deletes a message from their session.

Parameters:

Name	Type	Description
`Position`	Number
`Username`	String

Source:

instantiated.js, line 430

AccountEdit(Alias, Bio, Status, ProfileIMG_Url, Username)

Edits the session account.

Parameters:

Name	Type	Default
`Alias`	String
`Bio`	String
`Status`	String
`ProfileIMG_Url`	String
`Username`	String	null

Source:

instantiated.js, line 449

AccountExport()

Exports account data from the session.

Source:

instantiated.js, line 278

AccountImport(account_data)

Imports account data to the session.

Parameters:

Name	Type	Description
`account_data`	JSON

Source:

instantiated.js, line 291

AccountInfo(Username)

Looks for the account information.

Parameters:

Name	Type	Default	Description
`Username`	String	null

Source:

instantiated.js, line 481

AccountLoadData(Item)

Loads an item from your personal account.

Parameters:

Name	Type	Description
`Item`	String

Source:

instantiated.js, line 367

AccountLogin(username, password)

Logs in to your account in the session. Must be registered in your session.

Parameters:

Name	Type	Description
`username`	String
`password`	String

Source:

instantiated.js, line 306

AccountLogout()

Logs out of the session account.

Source:

instantiated.js, line 338

AccountProfileSearch(Username)

Searches the profile account from inside the session.

Parameters:

Name	Type	Description
`Username`	String

Source:

instantiated.js, line 467

AccountReadMail(mail_id, username)

Reads mail in your account. Hosts can use Username to read messages from the account.

Parameters:

Name	Type	Default	Description
`mail_id`	Number
`username`	String	null

Source:

instantiated.js, line 396

AccountRegister(username, password, alias)

Registers an account on the session.

Parameters:

Name	Type	Description
`username`	String
`password`	String
`alias`	String

Source:

instantiated.js, line 323

AccountSaveData(Item, Data)

Stores an item to your personal account.

Parameters:

Name	Type	Description
`Item`	String
`Data`	String

Source:

instantiated.js, line 352

AccountSendMail(To, Subject, TextMessage)

Sends mail to someone connected.

Parameters:

Name	Type	Description
`To`	String
`Subject`	String
`TextMessage`	String

Source:

instantiated.js, line 413

AccountUnassignRole(Username, RoleName)

Unassigns the account a role specified by the host.

Parameters:

Name	Type	Description
`Username`	String
`RoleName`	String

Source:

instantiated.js, line 542

AddClientToRole(RoleName, SocketID)

Adds the client to the role.

Parameters:

Name	Type	Description
`RoleName`	String
`SocketID`	Number

Source:

instantiated.js, line 1099

AddIPToWhitelist(IPAddress)

Adds the ip address to the whitelist.

Parameters:

Name	Type	Description
`IPAddress`	String

Source:

instantiated.js, line 1298

AddInstanceRule(Rule_String)

Adds the instance rule to the session.

Parameters:

Name	Type	Description
`Rule_String`	String

Source:

instantiated.js, line 990

AddSessionData(Item_, Data_, Password)

Adds/Updates the item from the session's storage.

Parameters:

Name	Type	Default
`Item_`	String
`Data_`	String
`Password`	String	null

Source:

instantiated.js, line 1388

AddSpammer(Username)

Adds someone to a spam list.

Parameters:

Name	Type	Description
`Username`	String

Source:

instantiated.js, line 871

AnnounceOnDiscord(Message, Type)

Announces the message to the instantiated discord under #session-loginfo.

Parameters:

Name	Type	Default	Description
`Message`	String
`Type`	String	maintenance

Source:

instantiated.js, line 572

BanIP(IPAddress, SocketID, Duration, Reason)

Bans the ip address from the session.

Parameters:

Name	Type	Description
`IPAddress`	String
`SocketID`	Number
`Duration`	EpochTimeStamp
`Reason`	String

Source:

instantiated.js, line 1267

BlockMailUser(Username)

Blocks a user from contacting you.

Parameters:

Name	Type	Description
`Username`	String

Source:

instantiated.js, line 895

ChangeInstancePassword(NewPassword)

Changes the instance's password.

Parameters:

Name	Type	Description
`NewPassword`	String

Source:

instantiated.js, line 557

ChangeSessionIcon(ImageURL)

Changes the session's icon from a image url.

Parameters:

Name	Type	Description
`ImageURL`	URL

Source:

instantiated.js, line 1441

Check_Newsletters()

Check's the newsletter displayed from instantiated.

Source:

instantiated.js, line 952

CloudAccountDelete()

Deletes your cloud storage account (Warning: Once this packet is sent, your account will be permanently deleted from the database. It may be recoverable if contacted about missing accounts.)

Source:

instantiated.js, line 708

CloudAdd(Key, Value)

Adds data to the cloud storage.

Parameters:

Name	Type	Description
`Key`	String
`Value`	String

Source:

instantiated.js, line 617

CloudAppend(Key, Value)

Increments a value by either adding or inserting a string or number.

Parameters:

Name	Type	Description
`Key`	String
`Value`	String

Source:

instantiated.js, line 660

CloudGetValue(Key)

Returns the data from cloud storage.

Parameters:

Name	Type	Description
`Key`	String

Source:

instantiated.js, line 674

CloudInfo()

Returns the cloud information, such as your support code, storage structure and your size limits.

Source:

instantiated.js, line 697

CloudLogin(user, pass)

Logins to your cloud account. (Only have to use it once)

Parameters:

Name	Type	Description
`user`	String
`pass`	String

Source:

instantiated.js, line 588

CloudRegister(user, pass)

Registers an account with the cloud services.

Parameters:

Name	Type	Description
`user`	String
`pass`	String

Source:

instantiated.js, line 602

CloudRemove(Key)

Grabs the item from cloud storage.

Parameters:

Name	Type	Description
`Key`	String

Source:

instantiated.js, line 646

CloudReset()

Resets the cloud storage to zero. This action cannot be undone.

Source:

instantiated.js, line 686

CloudUpdate(Key, Value)

Updates the data from the cloud storage.

Parameters:

Name	Type	Description
`Key`	String
`Value`	String

Source:

instantiated.js, line 632

ComposeMail(To, Subj, Msg, invite)

Sends a message to someone with the invite code if specified.

Parameters:

Name	Type	Default
`To`	String
`Subj`	String
`Msg`	String
`invite`	String	null

Source:

instantiated.js, line 786

CreateInvite(max_use)

Creates an invite code for users to join with. (Does not bypass bans or passwords.)

Parameters:

Name	Type	Description
`max_use`	Number

Source:

instantiated.js, line 251

CreateMailFolder(NewFolder)

Creates a new folder in the mail account.

Parameters:

Name	Type	Description
`NewFolder`	String

Source:

instantiated.js, line 859

CreateRole(RoleName, Color)

Creates the role with a specified color if defined.

Parameters:

Name	Type	Default	Description
`RoleName`	String
`Color`	Color	#ff0000

Source:

instantiated.js, line 1050

CreateServer(Session_ID, AppTitle, MaxConnections, Whitelist, Password, DefaultValues, AnnounceOpenSession)

Parameters:

Name	Type	Default
`Session_ID`	String
`AppTitle`	String
`MaxConnections`	Number
`Whitelist`	Boolean
`Password`	String
`DefaultValues`	Boolean
`AnnounceOpenSession`	Boolean	false

Source:

instantiated.js, line 142

CreateSession(AppTitle, MaxConnections, Whitelist, Password, RootPassword, DefaultValues, ForceHostTransfer, KillHostServer, AnnounceOpenSession)

Creates a new session to host.

Parameters:

Name	Type	Default
`AppTitle`	String
`MaxConnections`	Number
`Whitelist`	Boolean
`Password`	String
`RootPassword`	String
`DefaultValues`	Boolean
`ForceHostTransfer`	Boolean
`KillHostServer`	Boolean
`AnnounceOpenSession`	Boolean	false

Source:

instantiated.js, line 116

DeleteInvite(code)

Deletes an invite code making it useless.

Parameters:

Name	Type	Description
`code`	String

Source:

instantiated.js, line 265

DeleteMail(FolderName, MailNumber)

Deletes the message to the folder.

Parameters:

Name	Type	Description
`FolderName`	String
`MailNumber`	Number

Source:

instantiated.js, line 830

DeleteMailAccount()

Deletes the mail account. This action cannot be undone. You must also be logged in.

Source:

instantiated.js, line 930

DeleteMailFolder(FolderName)

Deletes a folder from the mail account.

Parameters:

Name	Type	Description
`FolderName`	String

Source:

instantiated.js, line 919

DeleteRole(RoleName)

Delete's the role. Any client assigned to this role is automatically removed.

Parameters:

Name	Type	Description
`RoleName`	String

Source:

instantiated.js, line 1083

DeleteSessionItem(Item_, Password)

Deletes the item from the session's storage.

Parameters:

Name	Type	Default	Description
`Item_`	String
`Password`	String	null

Source:

instantiated.js, line 1371

Disconnect()

Disconnects from the session.

Source:

instantiated.js, line 159

EditRoleColor(RoleName, Color)

Edit the role's color.

Parameters:

Name	Type	Description
`RoleName`	String
`Color`	Color

Source:

instantiated.js, line 1133

EditRolePermission(PermissionID, RoleName)

Edits the role's permission. If a permission is not defined from the permission's list it creates a definedpermission.

Parameters:

Name	Type	Description
`PermissionID`	String
`RoleName`	String

Source:

instantiated.js, line 1067

ExposeClientsIP()

Exposes the client's ip address if there connected to your session.

Source:

instantiated.js, line 940

GetInstanceMOTD()

Grabs the instance's message of the day.

Source:

instantiated.js, line 977

GetInstanceRules()

Grabs the instance rules and displays them as arrays.

Source:

instantiated.js, line 1036

GetMOTD()

Grabs Instantiated's message of the day. This is global.

Source:

instantiated.js, line 1211

GetRole()

Returns the role's id and outputs it in a string.

Source:

instantiated.js, line 64

Returns:

Role's ID String

GetSessionData(Item_, Password)

Grabs the data from the session's storage.

Parameters:

Name	Type	Default	Description
`Item_`	String
`Password`	String	null

Source:

instantiated.js, line 1355

GetSessionID()

Grabs the session id from the object and returns a string.

Source:

instantiated.js, line 99

Returns:

Session ID

GetSessionIcon()

Grabs the session's icon.

Source:

instantiated.js, line 1453

GetSocketID()

Grabs the socket id from the object and returns a number.

Source:

instantiated.js, line 90

Returns:

Socket ID

InspectSession(Inspection)

Inspects the session and outputs the inspection. Use "All" for grabbing everything.

Parameters:

Name	Type	Default	Description
`Inspection`	String	All

Source:

instantiated.js, line 1404

JoinServer(InstanceID, Password, Invitation_Code)

Joins the instance session if it's available.

Parameters:

Name	Type	Description
`InstanceID`	String
`Password`	String
`Invitation_Code`	String

Source:

instantiated.js, line 1249

Kick(SocketID, Reason)

Kicks the user from the session.

Parameters:

Name	Type	Description
`SocketID`	Number
`Reason`	String

Source:

instantiated.js, line 1339

LockInstance()

Locks the instance from accepting new connections.

Source:

instantiated.js, line 1221

LockRole(RoleName)

Lock's the role from being edited or removed. Only the instance host can manage this role.

Parameters:

Name	Type	Description
`RoleName`	String

Source:

instantiated.js, line 1160

MailListFolders()

Lists folders inside the mail account.

Source:

instantiated.js, line 746

MailListMailInFolder(FolderName)

Lists all the mail inside the folder.

Parameters:

Name	Type	Description
`FolderName`	String

Source:

instantiated.js, line 757

MailLogin(Username, Password)

Logs into your mail account.

Parameters:

Name	Type	Description
`Username`	String
`Password`	String

Source:

instantiated.js, line 734

MailRegister(Username, Password)

Registers a mail account.

Parameters:

Name	Type	Description
`Username`	String
`Password`	String

Source:

instantiated.js, line 720

MarkMailAsRead(FolderName, MailNumber)

Marks the message as read.

Parameters:

Name	Type	Description
`FolderName`	String
`MailNumber`	Number

Source:

instantiated.js, line 802

MarkMailAsUnread(FolderName, MailNumber)

Marks the message as un-read.

Parameters:

Name	Type	Description
`FolderName`	String
`MailNumber`	Number

Source:

instantiated.js, line 816

MoveMailToFolder(OldFolder, MailNumber, NewFolder)

Moves the message to a folder.

Parameters:

Name	Type	Description
`OldFolder`	String
`MailNumber`	Number
`NewFolder`	String

Source:

instantiated.js, line 845

Ping()

Pings the server that your alive. (times out at a minute.)

Source:

instantiated.js, line 226

PrivateSend(Json, Socket_ID)

Privately sends data to a connected socket.

Parameters:

Name	Type	Description
`Json`	JSON
`Socket_ID`	Number

Source:

instantiated.js, line 199

ReadMail(FolderName, MailNumber)

Reads the mail inside the folder.

Parameters:

Name	Type	Description
`FolderName`	String
`MailNumber`	Number

Source:

instantiated.js, line 770

Receive(Json)

Host sends data to all connected clients.

Parameters:

Name	Type	Description
`Json`	JSON

Source:

instantiated.js, line 185

RemoveClientFromRole(RoleName, SocketID)

Removes the role from the client.

Parameters:

Name	Type	Description
`RoleName`	String
`SocketID`	Number

Source:

instantiated.js, line 1116

RemoveIPFromWhitelist(IPAddress)

Removes the ip address from the whitelist.

Parameters:

Name	Type	Description
`IPAddress`	String

Source:

instantiated.js, line 1312

RemoveInstanceRule(RuleNumber)

Removes the instance rule from the session.

Parameters:

Name	Type	Description
`RuleNumber`	Number

Source:

instantiated.js, line 1005

RemoveSpammer(Username)

Removes someone to a spam list.

Parameters:

Name	Type	Description
`Username`	String

Source:

instantiated.js, line 883

ReportUserToHost(Against, Reason)

Reports the user to the session host.

Parameters:

Name	Type	Description
`Against`	Number
`Reason`	String

Source:

instantiated.js, line 1174

ReportUserToStaff(SocketID, MESSAGE)

Globally reports the user to the staff members of Instantiated.

Parameters:

Name	Type	Description
`SocketID`	Number
`MESSAGE`	String

Source:

instantiated.js, line 1199

SavePremiumSession(RootPassword)

Saves the premium session's data.

Parameters:

Name	Type	Description
`RootPassword`	String

Source:

instantiated.js, line 1481

SearchInstanceOnce(ApplicationTitle)

Searches the instance and finds the first one available.

Parameters:

Name	Type	Description
`ApplicationTitle`	String

Source:

instantiated.js, line 1429

SearchInstances(ApplicationTitle)

Searches the instance for the specified application title.

Parameters:

Name	Type	Description
`ApplicationTitle`	String

Source:

instantiated.js, line 1417

Send(Json)

Sends data to the host.

Parameters:

Name	Type	Description
`Json`	JSON

Source:

instantiated.js, line 171

SetInstanceMOTD(Message)

Sets the instance's message of the day.

Parameters:

Name	Type	Description
`Message`	String

Source:

instantiated.js, line 963

SetRole(RoleID)

Sets the role from the client.

Parameters:

Name	Type	Description
`RoleID`	String

Source:

instantiated.js, line 56

SetSessionID(InstanceID)

Sets the session id (which is required for any other calls.)

Parameters:

Name	Type	Description
`InstanceID`	String

Source:

instantiated.js, line 72

SetSocketID(SocketID)

Sets the socket id (optional but is required for GetSocketID())

Parameters:

Name	Type	Description
`SocketID`	Number

Source:

instantiated.js, line 81

SocketSend(Json, Socket_ID)

Sends data to a socket (does not need to join a session.)

Parameters:

Name	Type	Description
`Json`	JSON
`Socket_ID`	Number

Source:

instantiated.js, line 214

TakeControl(Password)

Takes control of the instance and transfers instance ownership to the new client.

Parameters:

Name	Type	Description
`Password`	String

Source:

instantiated.js, line 1234

ToggleWhitelist()

Toggles the whitelist from the session.

Source:

instantiated.js, line 1325

TransferOwnership(socket_id)

Transfers session ownership to someone else. (The host must initiate this.)

Parameters:

Name	Type	Description
`socket_id`	Number

Source:

instantiated.js, line 237

UnbanIP(IPAddress)

Unbans the ip address, allowing the session to join.

Parameters:

Name	Type	Description
`IPAddress`	String

Source:

instantiated.js, line 1284

UnblockMailUser(Username)

Unblocks a user from contacting you.

Parameters:

Name	Type	Description
`Username`	String

Source:

instantiated.js, line 907

UpdateInstanceRule(RuleNumber, Rule_String)

Updates the instance rule from an index. First rule is indexed at 0.

Parameters:

Name	Type	Description
`RuleNumber`	Number
`Rule_String`	String

Source:

instantiated.js, line 1021

ViewRoles()

Views the roles from the session. Anyone can request this at anytime.

Source:

instantiated.js, line 1148

WarnClient(Reason, SocketID)

Host warns the client with a specified reason.

Parameters:

Name	Type	Description
`Reason`	String
`SocketID`	Number

Source:

instantiated.js, line 1466

onClose(func)

Defines an on close event for when the connection was closed.

Parameters:

Name	Type	Description
`func`	function

Source:

instantiated.js, line 38

onError(func)

Defines an on error event for when the connection times out.

Parameters:

Name	Type	Description
`func`	function

Source:

instantiated.js, line 47

onMessage(func)

Defines an on message event listening to a event.data

Parameters:

Name	Type	Description
`func`	function

Source:

instantiated.js, line 29

onOpen(func)

Defines an on open connection for the websocket.

Parameters:

Name	Type	Description
`func`	function

Source:

instantiated.js, line 20