Class IUsesSessionControlMethods
Namespace: Unity.MARS.Providers
Syntax
public static class IUsesSessionControlMethods : objectMethods
CreateSession(IUsesSessionControl)
Create a new MR Session. If the session has been created, this does nothing.
Declaration
public static void CreateSession(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
DestroySession(IUsesSessionControl)
Pauses the MR Session. If a session has been paused, this does nothing.
Declaration
public static void DestroySession(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
PauseSession(IUsesSessionControl)
Resumes the MR Session. If a session has not has been paused, this does nothing.
Declaration
public static void PauseSession(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
ResetSession(IUsesSessionControl)
Resets the MR Session. This will trigger removal events
Declaration
public static void ResetSession(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
ResumeSession(IUsesSessionControl)
Create a new MR Session. If the session has been created, this does nothing.
Declaration
public static void ResumeSession(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
SessionExists(IUsesSessionControl)
Check if the session exists, regardless of whether it is running
Declaration
public static bool SessionExists(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
Returns
| Type | Description |
|---|---|
| Boolean | True if the session exists, false otherwise |
SessionReady(IUsesSessionControl)
Check if the session is ready
Declaration
public static bool SessionReady(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
Returns
| Type | Description |
|---|---|
| Boolean | True if the session is ready, false otherwise |
SessionRunning(IUsesSessionControl)
Check if the session is running. If the session does not exist, returns false
Declaration
public static bool SessionRunning(this IUsesSessionControl obj)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSessionControl | obj |
Returns
| Type | Description |
|---|---|
| Boolean | True if the session exists and is running, false otherwise |