Package apple.passkit.protocol

Interface PKIdentityDocumentDescriptor

All Known Implementing Classes:

PKIdentityDriversLicenseDescriptor

public interface PKIdentityDocumentDescriptor

"Descriptor" objects describe types of documents that can be requested. Different document types may have different sets of supported elements, functionality, or response formats. Clients should not define their own implementations of this protocol or subclass existing implementations. API-Since: 16.0

Method Summary

Modifier and Type	Method	Description
void	addElementsWithIntentToStore(@NotNull NSArray<? extends PKIdentityElement> elements, @NotNull PKIdentityIntentToStore intentToStore)	Adds the set of elements and associates them with the intent to store.
@NotNull NSArray<? extends PKIdentityElement>	elements()	Set of elements that will be requested from the document.
@Nullable PKIdentityIntentToStore	intentToStoreForElement(@NotNull PKIdentityElement element)	Intent to store for the given element, or nil if the element has not been added to this descriptor.

Method Detail

addElementsWithIntentToStore

void addElementsWithIntentToStore(@NotNull
                                  @NotNull NSArray<? extends PKIdentityElement> elements,
                                  @NotNull
                                  @NotNull PKIdentityIntentToStore intentToStore)

Adds the set of elements and associates them with the intent to store. This method can be called multple times with the same intent to store to append additional elements. If the same element is specified multiple times with different intents to store, the most recent one wins.

elements

@NotNull
@NotNull NSArray<? extends PKIdentityElement> elements()

Set of elements that will be requested from the document.

intentToStoreForElement

@Nullable
@Nullable PKIdentityIntentToStore intentToStoreForElement(@NotNull
                                                          @NotNull PKIdentityElement element)

Intent to store for the given element, or nil if the element has not been added to this descriptor.