Interface IPublisher

The IPublisher abstracts the process of publishing and downloading cloud anchors.

Namespace: Microsoft.MixedReality.WorldLocking.ASA

Assembly: cs.temp.dll.dll

Syntax

public interface IPublisher

Properties

Status

Get the current status, including progress to readiness to create.

Declaration

ReadinessStatus Status { get; }

Property Value

Type	Description
ReadinessStatus

Remarks

The publisher processes requests when its ReadinessStatus.readiness == Readiness.Ready. If that is not the current status, methods will return an error, unless otherwise noted.

Methods

Create(LocalPegAndProperties)

Create a cloud anchor corresponding to the input local peg and its properties.

Declaration

Task<string> Create(LocalPegAndProperties pegAndProps)

Parameters

Type	Name	Description
LocalPegAndProperties	pegAndProps	Peg and properties to be captured to the cloud.

Returns

Type	Description
Task<String>	Awaitable identifier for the cloud anchor.

CreateLocalPeg(String, Pose)

Create a local position holder blob.

Declaration

Task<ILocalPeg> CreateLocalPeg(string id, Pose lockedPose)

Parameters

Type	Name	Description
String	id	Unique name to give the local peg.
Pose	lockedPose	The position in WLT.LockedSpace to capture

Returns

Type	Description
Task<ILocalPeg>	Awaitable created blob.

Remarks

This can be called anytime, regardless of the ReadinessStatus. See ILocalPeg for more details.

Delete(String)

Delete the indicated cloud anchor from the cloud database.

Declaration

Task Delete(string cloudAnchorId)

Parameters

Type	Name	Description
String	cloudAnchorId	Cloud anchor to destroy.

Returns

Type	Description
Task	Awaitable task.

Find(Single)

Search the area around the device for cloud anchors.

Declaration

Task<Dictionary<string, LocalPegAndProperties>> Find(float radiusFromDevice)

Parameters

Type	Name	Description
Single	radiusFromDevice	Distance (roughly) from device to search.

Returns

Type	Description
Task<Dictionary<String, LocalPegAndProperties>>	Awaitable dictionary of cloud anchor ids and corresponding local peg and properties.

Modify(String, LocalPegAndProperties)

Delete a cloud anchor, and create a new one based on input local peg and its properties.

Declaration

Task<string> Modify(string cloudAnchorId, LocalPegAndProperties pegAndProps)

Parameters

Type	Name	Description
String	cloudAnchorId	Cloud anchor to delete.
LocalPegAndProperties	pegAndProps	Local anchor and properties to create new cloud anchor from.

Returns

Type	Description
Task<String>	Awaitable identifier for the new cloud anchor.

PurgeArea(Single)

Search the area around the device, and destroy any anchors found.

Declaration

Task PurgeArea(float radius)

Parameters

Type	Name	Description
Single	radius	Distance (roughly) from device to search.

Returns

Type	Description
Task	Awaitable task.

Read(IReadOnlyCollection<String>)

Download a list of cloud anchors by id.

Declaration

Task<Dictionary<string, LocalPegAndProperties>> Read(IReadOnlyCollection<string> cloudAnchorIds)

Parameters

Type	Name	Description
IReadOnlyCollection<String>	cloudAnchorIds	List of ids to download.

Returns

Type	Description
Task<Dictionary<String, LocalPegAndProperties>>	Dictionary of LocalPegAndProperties by cloudAnchorId.

Remarks

If any cloud anchor ids have already been downloaded this session, and are still retained, those cached records will be refreshed and returned.

Read(String)

Download a cloud anchor with the given identifier.

Declaration

Task<LocalPegAndProperties> Read(string cloudAnchorId)

Parameters

Type	Name	Description
String	cloudAnchorId	Identifier for the desired cloud anchor.

Returns

Type	Description
Task<LocalPegAndProperties>	Awaitable local peg and its properties that were used to create the cloud anchor are reconstructed and returned.

ReleaseLocalPeg(ILocalPeg)

Free up the resources from an ILocalPeg.

Declaration

void ReleaseLocalPeg(ILocalPeg peg)

Parameters

Type	Name	Description
ILocalPeg	peg	The peg to clean up.

Remarks

Param "peg" will be invalid after this call.