Error Codes¶
Strix Unity SDK has an error code system
that tells a cause of an error in a uniform way
across may operations.
An error code is primarily provided on the errorCode
property
on ErrorCodeException
,
which in turn may be available by downcasting the value of
cause
property of an argument passed to a failure callback handler.
The type of an error code is int (System.Int32
),
and symbolic names of various error codes are defined as constant fields
across several classes by categories.
Common Errors¶
Namespace: SoftGear.Strix.Client.Core.Error
Class: StandardErrorCode
Code |
Field name |
Description |
---|---|---|
0 |
UnknownError |
An unknown error occurred |
1 |
InternalError |
An internal error occurred |
2 |
PermissionDenied |
Permission is denied for the attempted action |
3 |
LockFailed |
A lock failed |
4 |
LockTimeout |
Timeout while attempting a lock |
5 |
InstantiationFailed |
Failed to instantiate Strix |
6 |
NoSuchProperty |
The property being accessed does not exist |
7 |
InvalidPropertySetting |
The property setting is invalid |
8 |
IncorrectMessageType |
Received an incorrect message type |
9 |
RequestTimeout |
A timeout was reached on a request |
10 |
ModelNotFound |
The model was not found |
11 |
ConnectionError |
Could not connect to the server |
Authentication Errors¶
Namespace: SoftGear.Strix.Client.Core.Auth.Error
Class: AuthErrorCode
Code |
Field name |
Description |
---|---|---|
1000 |
DuplicateConnectionForSameUid |
Attempting to connect to same connection with same unique identifier |
1001 |
CouldNotCalculateHash |
Could not calculate SHA hash |
1002 |
InvalidCredentialsType |
Authorization credentials are of the wrong type |
1003 |
InvalidCredentialsValue |
Authorization credentials are invalid |
1004 |
WrongCredentials |
Authorization credentials do not match authorized credentials |
1005 |
DuplicateUid |
Attempting to use a duplicate UID |
1006 |
UnsupportedLibraryVersion |
The library version you are using is unsupported |
1007 |
InvalidApplicationIdToken |
The application ID token you are using is invalid |
1008 |
ApplicationIdRequired |
Connection requires an application ID |
1009 |
UserNotFound |
The requested user could not be found |
1010 |
InvalidDigest |
Invalid hash |
1011 |
InvalidNonce |
Invalid nonce |
1012 |
NonceExpired |
The nonce value is out of date |
1013 |
NonceGenerationFailed |
Failed to generate a nonce value |
1014 |
RegisterFailed |
Failed to register a client |
1015 |
TokenAuthorizationRequired |
Requires token authorization |
1016 |
AuthorizationNotEnabled |
Attempting to perform authentication when it is not enabled |
Session Errors¶
Namespace: SoftGear.Strix.Client.Core.Session.Error
Class: SessionErrorCode
Code |
Field name |
Description |
---|---|---|
2000 |
InvalidSessionToken |
The token for this session is invalid |
2001 |
SessionNotFound |
The session could not be found |
Messenger Errors¶
Namespace: SoftGear.Strix.Client.Messenger.Error
Class: MessengerErrorCode
Code |
Field name |
Description |
---|---|---|
3000 |
SendingToSelfUidNotAllowed |
Attempting to send to yourself |
Node Server Errors¶
Namespace: SoftGear.Strix.Client.Node.Error
Class: NodeErrorCode
Code |
Field name |
Description |
---|---|---|
4000 |
NoNodesAvailable |
There are no nodes available to connect |
4001 |
NodeAlreadyExists |
Attempting to create node when it already exists |
Room Errors¶
Namespace: SoftGear.Strix.Client.Room.Error
Class: RoomErrorCode
Code |
Field name |
Description |
---|---|---|
5000 |
MessageLimitReached |
Too many messages per second for this room |
5001 |
NotRoomMember |
Attempting to operate on a room member that is not in this room |
5002 |
NotRoomOwner |
This room member is not the room owner |
5003 |
RoomFullOfMembers |
Room is full |
5004 |
RoomNotFound |
The room could not be found |
5005 |
RoomMemberNotFound |
The room member could not be found |
5006 |
NotAllowedForOtherRoomMember |
Cannot perform this operation on another room member |
5007 |
AlreadyInRoom |
Trying to connect to a room while already connected |
5008 |
WrongRoomPassword |
Incorrect password for this room |
5009 |
RoomNotJoinable |
Attempting to join an unjoinable room |
5010 |
NoRoomsAvailable |
No rooms available |
5011 |
MaxRoomCountReached |
Cannot create anymore rooms on this server |
Replica Errors¶
Namespace: SoftGear.Strix.Client.Replica.Error
Class: ReplicaErrorCode
Code |
Field name |
Description |
---|---|---|
6000 |
NotReplicaOwner |
Cannot perform this operation if not the owner of this replica |
6001 |
NotRoomMember |
Cannot perform this operation if not a room member |
6002 |
NotRoomOwner |
Cannot perform this operation if not a room owner |
6003 |
WrongPropertyMapFormat |
Incorrect formatting of the property map for this replica |
6004 |
ReplicaNotSynchronized |
Replica is not currently being synchronized |
Match Room Errors¶
Namespace: SoftGear.Strix.Client.Match.Error
Class: MatchErrorCode
Code |
Field name |
Description |
---|---|---|
7000 |
SelfKickProhibited |
A room member cannot kick itself |