Class ScopeRequest

Data structure with configuration for a new scope

Inheritance

object

ScopeRequest

Namespace: Transit.Shared.DataModels.Exchange

Assembly: Transit.Shared.dll

Syntax

public class ScopeRequest

Remarks

Use the static methods to create scope requests

Properties

Owner

Gets or sets owner.

Declaration

public string Owner { get; set; }

Property Value

Type	Description
string	The Link source GUID that owns this scope

Methods

ForImportDownload(string, string, string)

Creates a scope request for downloading data with the import api

Declaration

public static ScopeRequest ForImportDownload(string importSourceAid, string linkSourceUid, string linkSourceAid)

Parameters

Type	Name	Description
string	importSourceAid	The AID of the import source
string	linkSourceUid	The GUID of the link source.
string	linkSourceAid	The AID of the link source

Returns

Type	Description
ScopeRequest	A ScopeRequest for import downloads

Exceptions

Type	Condition
Exception	Thrown when any of the provided values are invalid.

ForImportUpload(string, string, string, ImportDataType[])

Creates a scope request for uploading data with the import api

Declaration

public static ScopeRequest ForImportUpload(string importSourceAid, string linkSourceUid, string linkSourceAid, ImportDataType[] dataTypes)

Parameters

Type	Name	Description
string	importSourceAid	The AID of the import source
string	linkSourceUid	The GUID of the link source.
string	linkSourceAid	The AID of the link source
ImportDataType[]	dataTypes	The supported datatypes for the upload

Returns

Type	Description
ScopeRequest	A ScopeRequest for import uploads

Exceptions

Type	Condition
Exception	Thrown when any of the provided values are invalid.

ForUpdate(string, bool)

Creates a scope request for updating an existing scope

Declaration

public static ScopeRequest ForUpdate(string scope, bool isEnabled)

Parameters

Type	Name	Description
string	scope	The scope to update
bool	isEnabled	true if enabled, otherwise false

Returns

Type	Description
ScopeRequest	A ScopeRequest for updating an existing scope