Message: RestoreOrJoinSessionResult

File: WebAPI/user_session_2.proto

Description

Result of session restore or join attempt.

Request: RestoreOrJoinSession.

Used in

ServerMsg

Fields

result_code

Type: uint32

Description: Session restore/join result. This field is associated with the ResultCode enum type.

base_time

Type: string

Description: See: LogonResult.base_time.

text_message

Type: string

Description: Optional failure details.

server_time

Type: sint64

Description: Time when the message was sent.

dialect_id

Type: string

Description: Session default dialect ID for used symbols.

See: Logon.dialect_id.

inactivity_timeout

Type: uint32

Description: Timeout for session inactivity, in minutes. It is the client’s responsibility
to track activity and disable or close the session after the timeout.

Enum ResultCode

Values

•      RESULT_CODE_SUCCESS = 0

     User is logged in to the system.

•      RESULT_CODE_FAILURE = 104

     General failure.

•      RESULT_CODE_UNKNOWN_SESSION = 101

     The session is unknown to a server; client must perform standard logon procedure.

•      RESULT_CODE_ACCESS_DENIED = 102

     User is not allowed to perform session restore/join or the maximum connection number has been exceeded.

•      RESULT_CODE_INVALID_PARAMS = 103

     Some RestoreOrJoinSession message fields were not filled.