# MatrixClient
extends CommandoClient (opens new window)
# Constructor
new MatrixCord.MatrixClient(options)
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| options | MatrixClientOptions | ✔️ | none | Options for the client |
# Properties
# .matrixRegistry READONLY
The client's registry
Type: MatrixRegistry
# Methods
# .getColor(guildID)
Get the global color or color of the guild if guildID is specified
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| guildID | String (opens new window) | ✔️ | none | Id of a guild |
Returns: HEX color
# .getColorFromMsg(message)
Get the global color or color of the guild if the message was send in a guild
| Parameter | Type | Description |
|---|---|---|
| message | CommandoMessage (opens new window) | Most likely the message which triggered a command |
Returns: HEX color
# .setColor(color, guildID)
Set/Reset the global color or set/reset color of a guild if guildID is specified
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| color | null (opens new window) | String (opens new window) | ❌ | none | Null for default color or a valid HEX color |
| guildID | String (opens new window) | ✔️ | none | Id of a guild |
Returns: Boolean (opens new window)