RemoteIdsApi (api 1.1.1 API)

All Superinterfaces:

OptionalFieldsApi

All Known Subinterfaces:

ApplicationApi, AssetApi, AttachmentApi, ChecklistApi, CompanyApi, ConversationApi, GroupApi, LabelApi, RoomApi, SiteApi, UserApi, WorkOrderApi
```
@Deprecated
public interface RemoteIdsApi
extends OptionalFieldsApi
```
Deprecated.
since 1.1 / API version 2.15.0. Use the OptionalFieldsApi instead.

Base class for remote id interactions

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`Result<?>`	`addRemoteIds(String id, RemoteId... remoteIds)`	Deprecated. since 1.1 / API version 2.15.0.
`Result<?>`	`removeRemoteIds(String id, RemoteId... remoteIds)`	Deprecated. since 1.1 / API version 2.15.0.
`Result<? extends Collection<? extends RemoteIdSearchResult>>`	`searchByRemoteId(String remoteIdType, String remoteId)`	Deprecated. since 1.1 / API version 2.15.0.

Methods inherited from interface net.worcade.client.api.mixin.OptionalFieldsApi
addOptionalFields, getOptionalFields, removeOptionalFields

- Method Detail
  - searchByRemoteId
```
@Deprecated
Result<? extends Collection<? extends RemoteIdSearchResult>> searchByRemoteId(String remoteIdType,
                                                                              String remoteId)
```
    Deprecated.
    since 1.1 / API version 2.15.0. Use the OptionalFieldsApi instead.
    
    Search for entities with remote ids for the current authenticated application.
    
    Parameters:
    
    remoteIdType - Return all entities with the given type, regardless of value. If null, return all entities with a remote id.
    
    remoteId - Return all entities with the given id value. This parameter is ignored if `remoteIdType` is null.
  - addRemoteIds
```
@Deprecated
Result<?> addRemoteIds(String id,
                       RemoteId... remoteIds)
```
    Deprecated.
    since 1.1 / API version 2.15.0. Use the OptionalFieldsApi instead.
    
    Add a remote id to the given entity. Remote id objects can be created using Worcade.createRemoteId(String, String)
  - removeRemoteIds
```
@Deprecated
Result<?> removeRemoteIds(String id,
                          RemoteId... remoteIds)
```
    Deprecated.
    since 1.1 / API version 2.15.0. Use the OptionalFieldsApi instead.
    
    Remove a remote id from the given entity. Remote id objects can be created using Worcade.createRemoteId(String, String), or reused from Entity.getRemoteIds()