SCPListLocationsParameters

Objective-C


@interface SCPListLocationsParameters : NSObject

Swift

class ListLocationsParameters : NSObject

Parameters to be used when calling Terminal.shared.listLocations() to list the Location objects associated with an account.

See

https://stripe.com/docs/terminal/readers/connecting

  • A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    See

    https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-limit

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSNumber *limit;

    Swift

    var limit: NSNumber? { get set }

  • A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    See

    https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-ending_before

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *endingBefore;

    Swift

    var endingBefore: String? { get set }

  • A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    See

    https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-starting_after

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *startingAfter;

    Swift

    var startingAfter: String? { get set }

  • Initializes SCPListLocationsParameters with the given parameters.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLimit:(nullable NSNumber *)limit
                         endingBefore:(nullable NSString *)endingBefore
                        startingAfter:(nullable NSString *)startingAfter;

    Swift

    init(limit: NSNumber?, endingBefore: String?, startingAfter: String?)

    Parameters

    limit

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
    endingBefore

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
    startingAfter

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.