InternalRequestEndpoint

public protocol InternalRequestEndpoint

Protocol defining internal endpoints accepted when generating requests for the API. These endpoints contain relative uris and need to be wrapped by a RequestEndpoint to add server baseURL

  • uri

    The string value containing the endpoint’s actual URI.

    Note

    This value may contain tokens wrapped in braces that can be replaced at runtime with dynamic values.

    See also

    HTTPEndpoint.replacingTokens(_:)

    Declaration

    Swift

    var uri: String { get }
  • requiresAccessToken Default implementation

    Optional flag to indicate if the endpoint requires signing with a user’s access token.

    Note

    If not implemented by the conforming class, the protocol includes a default implementation that always indicates that the endpoint requires the user’s access token (returning true).

    Default Implementation

    Default implementation that always indicates that the endpoint requires the user’s access token.

    Declaration

    Swift

    var requiresAccessToken: Bool { get }