Share via


IPublisher.Read Method

Definition

Overloads

Read(IReadOnlyCollection<String>)

Download a list of cloud anchors by id.

Read(String)

Download a cloud anchor with the given identifier.

Read(IReadOnlyCollection<String>)

Download a list of cloud anchors by id.

public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,Microsoft.MixedReality.WorldLocking.ASA.LocalPegAndProperties>> Read (System.Collections.Generic.IReadOnlyCollection<string> cloudAnchorIds);
abstract member Read : System.Collections.Generic.IReadOnlyCollection<string> -> System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string, Microsoft.MixedReality.WorldLocking.ASA.LocalPegAndProperties>>
Public Function Read (cloudAnchorIds As IReadOnlyCollection(Of String)) As Task(Of Dictionary(Of String, LocalPegAndProperties))

Parameters

cloudAnchorIds
IReadOnlyCollection<String>

List of ids to download.

Returns

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.

Applies to

Read(String)

Download a cloud anchor with the given identifier.

public System.Threading.Tasks.Task<Microsoft.MixedReality.WorldLocking.ASA.LocalPegAndProperties> Read (string cloudAnchorId);
abstract member Read : string -> System.Threading.Tasks.Task<Microsoft.MixedReality.WorldLocking.ASA.LocalPegAndProperties>
Public Function Read (cloudAnchorId As String) As Task(Of LocalPegAndProperties)

Parameters

cloudAnchorId
String

Identifier for the desired cloud anchor.

Returns

Awaitable local peg and its properties that were used to create the cloud anchor are reconstructed and returned.

Applies to