OidcNativeOptionsApple class

iOS / macOS options for the first-party ASWebAuthenticationSession flow.

Implemented types
Annotations
  • @JsonSerializable.new()

Constructors

OidcNativeOptionsApple({bool prefersEphemeralWebBrowserSession = false, Map<String, String>? additionalHeaderFields, OidcAppleCallbackMode callbackMode = OidcAppleCallbackMode.auto, Map<String, dynamic> rawSessionOptions = const {}, int? flowTimeoutSeconds, OidcAppleNavigationMode navigationMode = OidcAppleNavigationMode.asWebAuthenticationSession, String? successfulPageResponse, String? methodMismatchResponse, String? notFoundResponse, Future<bool> launchUrl(Uri url)?})
const
OidcNativeOptionsApple.fromJson(Map<String, dynamic> src)
factory

Properties

additionalHeaderFields → Map<String, String>?
Extra HTTP headers added to the initial authorization request (additionalHeaderFields, iOS 17.4 / macOS 14.4+; ignored before that).
final
callbackMode → OidcAppleCallbackMode
Which ASWebAuthenticationSession.Callback type to use.
final
flowTimeoutSeconds → int?
Maximum seconds the native ASWebAuthenticationSession flow may wait for a redirect before auto-cancelling with USER_CANCELLED.
final
hashCode → int
The hash code for this object.
no setterinherited
launchUrl → Future<bool> Function(Uri url)?
Test seam: overrides the browser-launch mechanism for the OidcAppleNavigationMode.loopbackSystemBrowser flow. When null (default), oidc_darwin falls back to package:url_launcher.
final
methodMismatchResponse → String?
The HTML body returned to the browser when a method other than GET is requested on the loopback listener (only used when navigationMode is OidcAppleNavigationMode.loopbackSystemBrowser).
final
How the macOS flow reaches the OpenID Provider.
final
notFoundResponse → String?
The HTML body returned to the browser when a request hits a path other than the redirect path on the loopback listener (only used when navigationMode is OidcAppleNavigationMode.loopbackSystemBrowser).
final
prefersEphemeralWebBrowserSession → bool
Whether to use an ephemeral session (no shared cookies/cache).
final
rawSessionOptions → Map<String, dynamic>
Escape hatch: arbitrary serializable session options forwarded verbatim (read defensively / availability-guarded native-side).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
successfulPageResponse → String?
The HTML body returned to the browser when the loopback listener matches the redirect (only used when navigationMode is OidcAppleNavigationMode.loopbackSystemBrowser).
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