SkyFrost.Base

This represents the current version of the asset variant system. Incrementing this will make sure that any old systems will not receive any jobs generated with this version, since they do not support the latest changes made and could corrupt the system if they attempted to process those new variants.

This interface collects all the individual clients that use the SignalR service

This interface is used for debugging the system and isn't normally used in production.

Is called as response to the Ping call. Used for debugging purposes

Matches the index passed to the Ping call

Used for debugging. Called on client to receive a debug message.

Debug message that is being received

This interface handles the messaging system - sending and receiving messages

Called on client when they should receive a message from another user.

The message to be received

Called on client when they send a message. This is so the message can be added to history on other signed sessions.

The message that was sent

Called on client when one or more messages have been read by users

Batch of the messages that were read (can be one or more)

This interface is for receiving any global moderation messages that clients might need to react to.

Called on client when an user has been public banned

Called on client when user has been mute banned

Called on client when user has been spectator banned

This interface is used for clients to exchange their current status - profile, online status, sessions and such

Called on client when user's status has been updated

The updated user status

Called on client when a given user should receive full status update (e.g. they just logged in)

User who to send the status update to

Called on client when one of their contacts has been updated. Used to sync status between active sessions. E.g. when user adds a new contact or accepts/ignores them. Also called when they receive a contact request.

New or Updated contact

Called on the client when the session info has been added or created.

Data of the new/updated session

Called when session is to be removed (e.g. when it ends)

The id of the session that is to be removed Timestamp of the removal

Called when a new listener is registered on particular broadcast key

This instructs the target to poke the target over LNL. This can be useful to help establish LNL connections, particularly within corporate networks.

Which connection is expected to poke The target address to poke Target port to poke

Used to expose Host configuration to SkyFrost.Base.

A universe ID to filter the session list by

Fills the UserStatus with user's currently active sessions

Submits a request to the cloud to obtain the network nodes for relays, bridges, etc.

Universe ID to obtain nodes against. What nodes are preferred for retrieval. Nodes that are specified for the universe, and given node preference.

Login user and create new UserSession for authenticating further requests. To authenticate self, either password, session token or recover code should be provided.

User's credential. Typically username or email Entity containing authentication information for given user Secret machine ID used to identity the machine that the login is from Whether this session should be saved and reused. This keeps the validity of the session token for longer TOTP code when user has 2FA enabled

This can be used to activate/continue an existing session, without explicit Login process. This method is useful in scenarios where the session needs to be continued without invalidating the existing session token. However it should be used ONLY in those circumstances, when it's absolutely necessary. Generally it's recommened to create new UserSession with the old token for security reasons, as it keeps the lifetime of those tokens pretty short.

Existing session to activate Crypto data for digital signing

Gets a user from a user ID.

User ID Ban access key

Gets a user by username.

Username

Submits a new user registration

Gets the registration status of a user

Gets session data for a user whose registration finished processing

Unique ID for the invite request. This is done for validation to prevent abuse.

This is the user who is requesting UserId. We store it explicitly, because the invite request can be forwarded to the host - meaning the message the host receives won't be coming from the user who wants to be invited.

The username of the user to be invited. This is so it doesn't need to be fetched from the cloud

This is the user that the invite was original requested from. This is for when this is forwarded, so the system can show who is the originator of the forwarding

Username of the user who the invite was originally requested from. This is so it doesn't need to be re-fetched

This is the session ID that this is being requested for. This is added when a user forwards this request. It's important to include this explicitly, because the user this is forwarded to might not be in the same session at the time they receive it.

The name of the session at the time of the request. This should be used as fallback to display the session name when it cannot be found based on the session ID, but when it can that should be preferred as it will have more up to date name of the session.

This indicates if the user who wants to be invited is currently contact with the host of the session. When the invite request is forwarded by the headless host, it'll fill this, so the user handling the request can get proper UI to add them as a host or no

This indicates what type of response is given to the invite request. This comes into play when the response is forwarded, because the action might need to be done on the different account than the one doing the actual resopnse - e.g. when headless forwards message to admin - the headless needs to know how to handle that

When the invite request is granted and needs to be forwarded, this contains the session info for the invite

Configuration of account migration task, determining what should be migrated.

Should user profile be migrated?

Should funding events be migrated?

Should exit messages be migrated?

Should contacts be migrated?

Should contact message history be migrated?

Should cloud variables be migrated?

Should records beloning to user be migrated? Doesn't affect group migration

Should the record audit record be migrated? This is shared for both user and groups (if they migrate)

Should the old cloud home be preserved? Homes migrate under a different RecordId to avoid conflicts When this is true, the migration system will force a favorite to the old home

Optional list of records to migrate

Optional list of variables to migrate

Should only the latest records be migrated?

Force overwrite synced records even if there's a conflict

Should groups be migrated?

Optional list of groups to migrate. If empty, all of them will be migrated.

True if this migration config has at least one migration option checked.

Status of the migration task

Represents the "phase" of the transfer E.g. Contacts, User Records etc

When was the migration started on

When was the migration completed

Migration status of the records of the user

Migration status of the variables of the user

Average number of records that are migrated per minute

Name of the entity that's being currently migrated (either the username or group name)

Name of the individual item that's being currently migrated

Total number of contacts (and their messages) to migrate

Number of contacts that have already been fully migrated (including their message history)

Total number of messages that have been already migrated.

Number of groups to migrate for given user

Number of groups that were completely migrated (including their records transferred)

Assets that for some reason were missing on the source and could not be uploaded. Mainly for diagnostic purposes, but could be used in the future to try to relocate those.

If the migration failed

Indicates if the messages have failed to migrate

Indicates if the migration should be aborted

Migration statuses of the groups

Task for a cloud-based account migration, representing its configuration and current status

Owner of the migration task (must be the user)

Unique id of the migration task

Name of the migratoin task

Description of the account migration task

Current state of the migration task

A rough estimate of where is this migration task in the queue (how many other tasks are in front of it)

When was this migration task created

How many times has the migration started. Values larger than 1 indicate failures

Last main error that's been logged for this whole task. Only for debugging purposes

Current status of the migration job

Current status of the migration job. This is a composite of all the run statuses, to provide a complete information in case the migration fails due to a bug. Statuses of the individual runs are in the RunStatuses

Indicates if contacts completed migration

Indicates if user owned entities have completed migration

Indicates which groups completed migration

Statuses of all the runs/attempts

Represents current status of a group to migrate

OwnerID of the group

Name of the group

Were members already migrated? It doesn't make sense to have progress indicator for this, because there's barely any data to go with this.

Status of the migrated records

Migration status of the variables of the group

Contains all necessary data to initialize a migration process from a source infrastructure

Configuration for the source cloud

TOTP code for the source infrastructure

Session for the source infrastructure

The UID used to generate this data. This is explicitly stored, so it can be used by the cloud during the migration process. The session tokens can be verified against the UID, to prevent leaked tokens from being abused. Since the cloud is handling the actual migration, we'll need to provide it explicitly

The secret machine ID generated specifically for this migration. This is necessary for the migration to function, because the cloud verifies if the session token matches the SecretMachineID. We just generate a random one for the purposes of migration, so it cannot be used for anything else.

The actual migration task to be performed

Total number of records to be migrated

Total number of records that were migrated

Total number of records that were already migrated and were skipped

How many records have conflicted

Total number of records that were processed

Debug description of the current search phase for the records

How many bytes need to be uploaded

How many bytes were already uploaded

How many assets need to be uplaoded

How many assets were uploaded

Which records are currently being migrated

Records that failed to migrate

Represents if users in the session will get auto-kicked wheb they have been away from the session for longer than the time period listed in AwayKickMinutes.

Represents how long a user must be away from the session before they are auto-kicked, represented in total minutes.

Profile of the entire platform, containing common names, ID's, schemes and accounts

How will the client identity itself to the API.

Version of the product that it will identify as.

Enable GZip compression for requests and responses. This can decrease latency and signififcantly decreate the bandwidth necessary to communicate with the API. On some platforms it causes trouble though (e.g. Linux) so must be disabled.

Proxy settings to use when initializing SkyFrost.

URL of the main endpoint for API calls

Endpoint where SignalR hub is located

Force the use of long polling for SignalR. This can be useful if the connection is having issues with websockets for some reason

Endpoint that can be checked for current status of the API. This generally should be different from the ApiEndpoint, because if that one is down, then requests to this one would fail as well.

If the target endpoint is hidden under a secret access key, it needs to be provided there

URL for initiating SAML 2.0 login

Default timeout for the web requests. Should be reasonably low, so if there are transient errors, the request doesn't hang for too long, but also not too short that network glitches would cause requests to fail.

The interface used to communicate with the cloud asset system for downloading and uploading assets.

Manager for gathering network node information - e.g. matchmaker and relays

Name of the URL path for contacts. This is to support legacy API which used "friends"

Indicates if needs to use the legacy login method

The current universe the client is using to interact with SkyFrost. Gets used for various requests.

Hash of the session ID (+ salt from the user status) that the user is in This field uses hash so only users who already have data of given session can determine that the user is in this session, but other users cannot. The session hash might be null if the user is present in a session that is private, to completely hide its identity.

Access level of this session

Indicates if this session is hidden from listing

Is the user owning this status the host of the session this represents?

BroadcastKey under which updates for this session can be received. This is used for certain types of sessions, like Contacts+, so anyone who becomes aware of the broadcast key can actually receive updates on this session

UserID that this status belongs to

Unique identifier of the user's current status session. User can have multiple concurrent sessions, e.g. being logged in the graphical client, while at the same time running headless and chat client. This allows those sessions from being distinguished from each other.

Identifies the type of session this represents

Current output device for graphical client. This can be used to tell if the user is in VR, screen, using camera or something else.

Is this session running on a mobile device?

The online status of this particular session, if applicable. Certain session types might be missing a status, e.g. Headless

Indicates if the user is currently present at this session

When is the last time that user was recorded as present in this session? Used to determine which of the statuses is the most "fresh"

Timestamp of the last time this session info has changed

Randomized salt used to compute the session hashes. This is to prevent people from determining which users are in the same session by matching their hashes. This salt can change frequently, potentially with every single update of user status, to help obfuscate which sessions is the user present in and how they change their status.

Version string of the app that the user is currently running on

The compatibility hash of the client that the user is running on. Can be null if not applicable. The future is now! This is deprecated now - compatibility is determined on per-session basis, instead of globally.

Public RSA parameters for authenticating user owning this status. The user generates private and public key pair when they start up the app. The public key can be fetched from the cloud under the user's ID and then used to verify any data signed by the user owning this, to ensure that they are who they claim to be.

Metadata of sessions that the user is currently present in. This requires having the actual session data to fully decode, as the session ID's are hashed with the user's salt

Index of the session (in the session metadata list) that the user is currently present in

Helper to fetch the metadata of the session that the user is currently in

Initializes the list of sessions to be filled, by generating new salt and ensuring there's a clear list

Adds metadata of given session to the list. Assumes that rest of the data have been properly initialized

Info of the session to add Indicates if given session is currently focused world Generated metadata for given sesesion

Given a list of session infos, this will try to find the session info corresponding to a given session metadata

List of the session info's to try to match Metadata for which the match is being searched for Matched session info if found, null otherwise

Determines if given session matches the session metadata for this user status.

The session information to match Metadata of the session to match against True if matches, False if not

Fills dictionary that maps session hashes represented by this status to their correspodning session infos

List of session infos to generate the map for Dictionary to fill in with the matched data

Determines if this status is dominant over another user status - that is if this one should be displayed as their primary status instead of the other status or not,

The status to compare this one to Whether the current status is dominant over the other status

The HttpTransports that SkyFrost will instruct SignalR to use.

Waits for a user's registration to complete

Error encountered, or null when successful

Given a ProxyConfig, usually sourced from creates an instance of .

ProxyConfig from A setup WebProxy, or null if the proxy is invalid.

Augments, an initial config with additional properties that might be avilable from other sources

Initial config which should be hydrated with additional data from other sources Hydrated config

Given some registry values in the form of a struct, parses them into valid proxy definitions.

Registry values, found in the windows registry. A proxy Configuration, sourced from the registry