Function SyncApiFp

Returns {
    adminGetFlexSync(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<SyncDataResponse>)>;
    adminGetSync(serviceId, groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<PbsSyncResponse>)>;
}

• adminGetFlexSync:function

  • adminGetFlexSync(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<SyncDataResponse>)>

  • Retrieve sync data for a specific Atlas App Services App when using Flexible Sync.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • serviceId: any

      The unique `_id` value of a service.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<SyncDataResponse>)>

    Summary

    Get Flexible Sync information

    Throws

• adminGetSync:function

  • adminGetSync(serviceId, groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<PbsSyncResponse>)>

  • Retrieve partition field data when using Partition-Based Sync.

    Parameters

    • serviceId: any

      The Service ID for the linked cluster.

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PbsSyncResponse>)>

    Summary

    Get Partition-Based Sync information

    Throws