PassData class

Annotations

• @JsonSerializable(includeIfNull: false)

Constructors

PassData({required String description, required int formatVersion, required String organizationName, required String passTypeIdentifier, required String serialNumber, required String teamIdentifier, String? appLaunchURL, List<int>? associatedStoreIdentifiers, Map<String, dynamic>? userInfo, DateTime? expirationDate, bool? voided, List<Beacon>? beacons, List<Location>? locations, num? maxDistance, DateTime? relevantDate, PassStructure? boardingPass, PassStructure? coupon, PassStructure? eventTicket, PassStructure? generic, PassStructure? storeCard, Barcode? barcode, List<Barcode>? barcodes, Color? backgroundColor, Color? foregroundColor, String? groupingIdentifier, Color? labelColor, String? logoText, bool? suppressStripShine, bool? sharingProhibited, String? authenticationToken, Uri? webServiceURL, Nfc? nfc, Semantics? semantics})

PassData.fromJson(Map<String, dynamic> json)

factory

Properties

appLaunchURL → String?

Optional. A URL to be passed to the associated app when launching it. The app receives this URL in the application:didFinishLaunchingWithOptions: and application:openURL:options: methods of its app delegate. If this key is present, the associatedStoreIdentifiers key must also be present.

final

associatedStoreIdentifiers → List<int>?

Optional. A list of iTunes Store item identifiers for the associated apps.

final

authenticationToken → String?

The authentication token to use with the web service. The token must be 16 characters or longer.

final

backgroundColor → Color?

Optional. Background color of the pass, specified as an CSS-style RGB triple. For example, rgb(23, 187, 82).

final

barcode → Barcode?

Optional. Information specific to the pass’s barcode. For this dictionary’s keys, see Barcode Dictionary Keys. Note:Deprecated in iOS 9.0 and later; use barcodes instead.

final

barcodes → List<Barcode>?

Optional. Information specific to the pass’s barcode. The system uses the first valid barcode dictionary in the array. Additional dictionaries can be added as fallbacks. For this dictionary’s keys, see Barcode Dictionary Keys. Note: Available only in iOS 9.0 and later.

final

beacons → List<Beacon>?

Optional. Beacons marking locations where the pass is relevant. For these dictionaries’ keys, see Beacon Dictionary Keys Available in iOS 7.0.

final

boardingPass → PassStructure?

Information specific to a boarding pass.

final

coupon → PassStructure?

Information specific to a coupon.

final

description → String

Required. Brief description of the pass, used by the iOS accessibility technologies.

final

eventTicket → PassStructure?

Information specific to an event ticket.

final

expirationDate → DateTime?

Optional. Date and time when the pass expires. The value must be a complete date with hours and minutes, and may optionally include seconds. Available in iOS 7.0.

final

foregroundColor → Color?

Optional. Foreground color of the pass, specified as a CSS-style RGB triple. For example, rgb(100, 10, 110).

final

formatVersion → int

Required. Version of the file format. The value must be 1.

final

generic → PassStructure?

Information specific to a generic pass.

final

groupingIdentifier → String?

Optional for event tickets and boarding passes; otherwise not allowed. Identifier used to group related passes. If a grouping identifier is specified, passes with the same style, pass type identifier, and grouping identifier are displayed as a group. Otherwise, passes are grouped automatically. Use this to group passes that are tightly related, such as the boarding passes for different connections of the same trip. Available in iOS 7.0.

final

hashCode → int

The hash code for this object.

no setter, inherited

labelColor → Color?

Optional. Color of the label text, specified as a CSS-style RGB triple. For example, rgb(255, 255, 255). If omitted, the label color is determined automatically.

final

locations → List<Location>?

Optional. Locations where the pass is relevant. For example, the location of your store. For these dictionaries’ keys, see Location Dictionary Keys.

final

logoText → String?

Optional. Text displayed next to the logo on the pass.

final

maxDistance → num?

Optional. Maximum distance in meters from a relevant latitude and longitude that the pass is relevant. This number is compared to the pass’s default distance and the smaller value is used. Available in iOS 7.0.

final

nfc → Nfc?

Optional. Information used for Value Added Service Protocol transactions. For this dictionary’s keys, see NFC Dictionary Keys. Available in iOS 9.0.

final

organizationName → String

Required. Display name of the organization that originated and signed the pass.

final

passTypeIdentifier → String

Required. Pass type identifier, as issued by Apple. The value must correspond with your signing certificate.

final

relevantDate → DateTime?

Recommended for event tickets and boarding passes; otherwise optional. Date and time when the pass becomes relevant. For example, the start time of a movie. The value must be a complete date with hours and minutes, and may optionally include seconds.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

semantics → Semantics?

You can augment the user-visible information on Wallet passes with machine-readable metadata known as semantic tags. The metadata in semantic tags helps the system better understand Wallet passes and suggest relevant actions for the user to take on their installed passes.

final

serialNumber → String

Required. Serial number that uniquely identifies the pass. No two passes with the same pass type identifier may have the same serial number.

final

sharingProhibited → bool?

A Boolean value introduced in iOS 11 that controls whether to show the Share button on the back of a pass. A value of true removes the button. The default value is false. This flag has no effect in earlier versions of iOS, nor does it prevent sharing the pass in some other way.

final

storeCard → PassStructure?

Information specific to a store card.

final

suppressStripShine → bool?

Optional. If true, the strip image is displayed without a shine effect. The default value prior to iOS 7.0 is false. In iOS 7.0, a shine effect is never applied, and this key is deprecated.

final

teamIdentifier → String

Required. Team identifier of the organization that originated and signed the pass, as issued by Apple.

final

userInfo → Map<String, dynamic>?

Optional. Custom information for companion apps. This data is not displayed to the user. For example, a pass for a cafe could include information about the user’s favorite drink and sandwich in a machine-readable form for the companion app to read, making it easy to place an order for “the usual” from the app. Available in iOS 7.0.

final

voided → bool?

Optional. Indicates that the pass is void—for example, a one time use coupon that has been redeemed. The default value is false. Available in iOS 7.0.

final

webServiceURL → Uri?

The URL of a web service that conforms to the API described in PassKit Web Service Reference. The web service must use the HTTPS protocol; the leading https:// is included in the value of this key. On devices configured for development, there is UI in Settings to allow HTTP web services.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited