MarcSyncClient
A class that represents a MarcSync client.
CONSTRUCTOR
.new(accessToken: string, options: ClientOptions?)
Creates a new MarcSync client.
When creating a new client, you must provide an accessToken. This argument can either be the key of the "tokens" table in the client's Class or the actual token itself. If you provide the key, the client will automatically try to fetch the token from the "tokens" table. If you provide the token itself, the client will use that token instead. If no token is found by the key provided, it will use the key as the token itself.
The options argument is optional and can be used to specify the options of the client. If you do not provide any options, the client will use the default options. The default options are as follows:
{
retryCount = 3
}
METHODS
:getVersion(clientId: number?)
Returns the version of the client. If there is no clientId specified, it will return the version of the client that is currently running. If there is a clientId specified, it will return the version of the client that is running on the specified clientId.
| clientId | Corresponding Client |
|---|---|
| 1 | Roblox Client |
| 2 | NodeJS Client |
:fetchCollection(collectionName: string)
Fetches a collection from the MarcSync API and returns it as a Collection object.
InvalidAccessToken - Thrown when the accessToken is invalid.
CollectionNotFound - Thrown when the collection does not exist.
:getCollection(collectionName: string)
Returns a collection from the MarcSync API as a Collection object. If the collection does not exist, you will get an exception upon trying to use the object.
:createCollection(collectionName: string)
Creates a new collection in the MarcSync API and returns it as a Collection object. If the collection already exists, you will get an exception.
InvalidAccessToken - Thrown when the accessToken is invalid.
CollectionAlreadyExists - Thrown when the collection already exists.