Class CompanionProjectUtils

Inheritance

Object

CompanionProjectUtils

Namespace: Unity.MARS.Companion.Core

Syntax

public static class CompanionProjectUtils

Fields

InvalidIDErrorBody

Declaration

public const string InvalidIDErrorBody = "Sorry, either the project ID is invalid, or you do not have access to this project. Make sure you are scanning the project ID, and not the API key."

Field Value

Type	Description
String

InvalidIDErrorTitle

Declaration

public const string InvalidIDErrorTitle = "Invalid project ID"

Field Value

Type	Description
String

Methods

AddNewProject(String)

Declaration

public static CompanionProject AddNewProject(string name = null)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
CompanionProject

AddOrUpdateProject(CompanionProject)

Declaration

public static void AddOrUpdateProject(CompanionProject currentProject)

Parameters

Type	Name	Description
CompanionProject	currentProject

DeleteProject(CompanionProject)

Declaration

public static bool DeleteProject(CompanionProject projectToDelete)

Parameters

Type	Name	Description
CompanionProject	projectToDelete

Returns

Type	Description
Boolean

DeleteProjects(List<String>)

Declaration

public static void DeleteProjects(List<string> idList)

Parameters

Type	Name	Description
List<String>	idList

LoadProjects()

Declaration

public static ProjectList LoadProjects()

Returns

Type	Description
ProjectList

TryImportProject(String, String, out String, out String)

Declaration

public static bool TryImportProject(string id, string name, out string errorTitle, out string errorBody)

Parameters

Type	Name	Description
String	id
String	name
String	errorTitle
String	errorBody

Returns

Type	Description
Boolean

TryLinkProject(String, String, String, out String, out String)

Declaration

public static bool TryLinkProject(string id, string name, string localIndex, out string errorTitle, out string errorBody)

Parameters

Type	Name	Description
String	id
String	name
String	localIndex
String	errorTitle
String	errorBody

Returns

Type	Description
Boolean

UnlinkProject(String)

Declaration

public static void UnlinkProject(string cloudId)

Parameters

Type	Name	Description
String	cloudId

Events

projectListSaved

Declaration

public static event Action<ProjectList> projectListSaved

Event Type

Type	Description
Action<ProjectList>