ChallengeListPayload

public struct ChallengeListPayload

Describes the information required to fetch a ChallengeList

  • The unique SID identifier of the Factor to which the ChallengeList is related

    Declaration

    Swift

    public let factorSid: String

  • Number of Challenges to be returned by the service

    Declaration

    Swift

    public let pageSize: Int

  • Sort challenges in order by creation date of the challenge

    Declaration

    Swift

    public let order: ChallengeListOrder

  • Status to filter the Challenges, if nothing is sent, Challenges of all status will be returned

    Declaration

    Swift

    public var status: ChallengeStatus?

  • Token used to retrieve the next page in the pagination arrangement

    Declaration

    Swift

    public var pageToken: String?

  • Creates a ChallengeListPayload with the given parameters

    Declaration

    Swift

    public init(factorSid: String, pageSize: Int, status: ChallengeStatus? = nil, order: ChallengeListOrder = .asc, pageToken: String? = nil)

    Parameters

    factorSid

    The unique SID identifier of the Factor to which the Challenge is related
    pageSize

    Number of Challenges to be returned by the service
    status

    Status to filter the Challenges, if nothing is sent, Challenges of all status will be returned
    order

    Sort challenges in order by creation date of the challenge
    pageToken

    Token used to retrieve the next page in the pagination arrangement