net.worcade.client.api.mixin.RemoteIdsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation

A library for interacting with the Worcade API

There is a newer version: 1.1.2

// Copyright (c) 2017, Worcade. Please see the AUTHORS file for details.
// All rights reserved. Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package net.worcade.client.api.mixin;

import net.worcade.client.Result;
import net.worcade.client.Worcade;
import net.worcade.client.get.Entity;
import net.worcade.client.get.RemoteId;
import net.worcade.client.get.RemoteIdSearchResult;

import java.util.Collection;

/**
 * Base class for remote id interactions
 */
public interface RemoteIdsApi {
    /**
     * Search for entities with remote ids for the current authenticated application.
     * @param remoteIdType Return all entities with the given type, regardless of value. If null, return all entities with a remote id.
     * @param remoteId Return all entities with the given id value. This parameter is ignored if `remoteIdType` is null.
     */
    Result> searchByRemoteId(String remoteIdType, String remoteId);

    /**
     * Add a remote id to the given entity. Remote id objects can be created using {@link Worcade#createRemoteId(String, String)}
     */
    Result addRemoteIds(String id, RemoteId... remoteIds);
    /**
     * Remove a remote id from the given entity.
     * Remote id objects can be created using {@link Worcade#createRemoteId(String, String)}, or reused from {@link Entity#getRemoteIds()}
     */
    Result removeRemoteIds(String id, RemoteId... remoteIds);
}