ContactAnnotationStore.GetAnnotationListAsync(String) Method

Reference

Definition

Namespace:: Windows.ApplicationModel.Contacts

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Asynchronously gets the ContactAnnotationList with the specified ID.

public:
 virtual IAsyncOperation<ContactAnnotationList ^> ^ GetAnnotationListAsync(Platform::String ^ annotationListId) = GetAnnotationListAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<ContactAnnotationList> GetAnnotationListAsync(winrt::hstring const& annotationListId);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<ContactAnnotationList> GetAnnotationListAsync(string annotationListId);

function getAnnotationListAsync(annotationListId)

Public Function GetAnnotationListAsync (annotationListId As String) As IAsyncOperation(Of ContactAnnotationList)

Parameters

annotationListId: String
Platform::String

winrt::hstring

The ID of the ContactAnnotationList to get.

Returns

IAsyncOperation<ContactAnnotationList>

The ContactAnnotationList with the ID specified in annotationListId.

Attributes: RemoteAsyncAttribute

Windows requirements

App capabilities

contactsSystem

Examples

The following example provides reusable methods for creating an annotation list, deleting a specific annotation list, and deleting all annotation lists in a store.

public async Task<ContactAnnotationList> CreateAnnotationList()
{
    // Get the data store.
    ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite);

    // Create a new list.
    ContactAnnotationList list = await store.CreateAnnotationListAsync();

    // Find the list to verify it was created.
    IReadOnlyList<ContactAnnotationList> lists = await store.FindAnnotationListsAsync();

    for (int i = 0; i < lists.Count; i++)
    {
        // Do the IDs match?
        if (list.Id == lists[i].Id)
        {
            // Found it! Return the new list.
            return(list);
        }
    }

    // List not created, return null.
    return(null);
}

public async Task<Boolean> DeleteAnnotationList(string listId)
{
    // Get the store.
    ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite);

    // Find the list.
    ContactAnnotationList list = await store.GetAnnotationListAsync(listId);

    // Make sure we got it.
    if (list.Id == listId)
    {
        // Delete the list.
        await list.DeleteAsync();
        return true;
    }

    return false;
}

public async Task<Boolean> DeleteAllAnnotationLists()
{
    // Get the store.
    ContactAnnotationStore store = await ContactManager.RequestAnnotationStoreAsync(ContactAnnotationStoreAccessType.AppAnnotationsReadWrite);

    IReadOnlyList<ContactAnnotationList> lists = await store.FindAnnotationListsAsync();

    // Make sure at least one annotation list exists.
    if (lists.Count > 0)
    {
        // Find the list.
        for (int i = 0; i < lists.Count; i++)
        {
            await lists[i].DeleteAsync();
        }

        return true;
    }

    return false;
}

Applies to

Jaa