Package net.worcade.client.api

Interface SearchApi

public interface SearchApi

Method Summary

Modifier and Type	Method	Description
Result<? extends Collection<? extends ReferenceWithName>>	searchByEmail(String email)
Result<? extends Collection<? extends RemoteIdSearchResult>>	searchByOptionalField(String ownerId, String name, String value)
Result<? extends Collection<? extends RemoteIdSearchResult>>	searchByRemoteId(String remoteIdType, String remoteId)	Deprecated. since 1.1 / API version 2.15.0.

Method Detail

searchByRemoteId

@Deprecated
Result<? extends Collection<? extends RemoteIdSearchResult>> searchByRemoteId(String remoteIdType,
                                                                              String remoteId)

Deprecated.

since 1.1 / API version 2.15.0. Use searchByOptionalField(String, String, String) 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.

searchByOptionalField

Result<? extends Collection<? extends RemoteIdSearchResult>> searchByOptionalField(String ownerId,
                                                                                   String name,
                                                                                   String value)

searchByEmail

Result<? extends Collection<? extends ReferenceWithName>> searchByEmail(String email)