DevicePinsModule

public class DevicePinsModule

Provides DevicePin management.

  • Retrieves a specified Device Pin.

    Declaration

    Swift

    public func get(
    devicePinId: String,
    fields: [String]? = nil,
    completion: @escaping Callback<DevicePin>
)

    Parameters

    fields

    Comma-separated list of fields to include in the response.
    completion

    Returns a full Device Pin object or an error.

  • Retrieves all Device Pins for an enterprise.

    Declaration

    Swift

    public func listForEnterprise(
    enterpriseId: String,
    marker: String? = nil,
    limit: Int? = nil,
    direction: OrderDirection? = nil,
    fields: [String]? = nil
) -> PagingIterator<DevicePin>

    Parameters

    enterpriseId

    The Id of the enterprise to retrieve Device Pins for.
    marker

    The position marker at which to begin the response. See marker-based paging for details.
    limit

    The maximum number of items to return. The default is 100 and the maximum is 1,000.
    direction

    This can be ASC or DESC.
    fields

    Comma-separated list of fields to include in the response.

  • Deletes the specified Device Pin.

    Declaration

    Swift

    public func delete(
    devicePinId: String,
    completion: @escaping Callback<Void>
)

    Parameters

    completion

    An empty response will be returned upon successful deletion.