OptionalParameters

public struct OptionalParameters

認可リクエスト時に指定する任意パラメーター。

  • 同意画面で「同意しない」ボタンをクリックした際の遷移先。 true: redirect_uriにcodeパラメーターを付加せず遷移。 false or nil: Yahoo! JAPAN TOPページへ遷移。

    Declaration

    Swift

    public var bail: Bool?

  • ログイン画面と同意画面で表示するページ種類。

    Declaration

    Swift

    public var display: Display?

  • 最大認証経過時間。 指定された秒数よりも認証日時が経過していた場合は再認証を要求。

    Declaration

    Swift

    public var maxAge: Int?

  • ユーザーに強制させたいアクション。

    Declaration

    Swift

    public var prompts: [Prompt]?

  • その他未定義のパラメーター。

    Note

    定義されていないパラメーターを指定したい場合に使用。

    Declaration

    Swift

    public var additionalParameters: [String : String]?

  • 指定されたパラメーターを元にインスタンスを生成。

    Declaration

    Swift

    public init(
    bail: Bool? = nil,
    display: Display? = nil,
    maxAge: Int? = nil,
    prompts: [Prompt]? = nil,
    additionalParameters: [String: String]? = nil
)

    Parameters

    bail

    同意画面で「同意しない」ボタンをクリックした際の遷移先。
    display

    ログイン画面と同意画面で表示するページ種類。
    maxAge

    最大認証経過時間。
    prompts

    ユーザーに強制させたいアクション。
    additionalParameters

    その他未定義のパラメーター。