A B C D F G H I L N R S T U V

A

addTrack(URI) - Method in class io.clarify.api.Bundle

Adds a new Track to the Bundle with the given media URI

addTrackToBundle(String, URI) - Method in class io.clarify.api.ClarifyClient

Adds a new Track to the Bundle with the given media URI, then fetches the resulting resource (resulting in 2 API calls)

B

baseUri() - Method in class io.clarify.api.ClarifyClient

Returns the base URI for the Clarify API

buildPathFromHref(String) - Method in class io.clarify.api.ClarifyClient

Helper to concatenate the base URI of the Clarify API with a given HREF

buildPathFromResourcePath(String) - Method in class io.clarify.api.ClarifyClient

Helper to concatenate the base URI of the Clarify API, the version, and a given resource path

Bundle - Class in io.clarify.api

Bundle(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.Bundle

BundleList - Class in io.clarify.api

Represents a List Bundles Clarify API response type, allowing the caller to obtain the raw list of links and to paginate through the results.

BundleList(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.BundleList

BundleMetadata - Class in io.clarify.api

Provides details on the stored Metadata for a specific media Bundle.

BundleMetadata(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.BundleMetadata

BundleSearchResults - Class in io.clarify.api

Represents a Search Bundles Clarify API response type, allowing the caller to obtain the matches, terms, and scores from the results, the list of search result items, and paginate through the results.

BundleSearchResults(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.BundleSearchResults

BundleTrack - Class in io.clarify.api

Represents a specific Track within a media Bundle

BundleTrack(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.BundleTrack

BundleTrackList - Class in io.clarify.api

Represents a Track List associated to a specific media Bundle.

BundleTrackList(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.BundleTrackList

C

CLARIFY_BASE_URI - Static variable in class io.clarify.api.ClarifyClient

ClarifyClient - Class in io.clarify.api

The starting point for the Clarify API Java SDK.

ClarifyClient(String) - Constructor for class io.clarify.api.ClarifyClient

ClarifyModel - Class in io.clarify.api

ClarifyModel(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.ClarifyModel

ClarifyPaginatedModel - Class in io.clarify.api

Base class for handling pagination within the Clarify Java SDK.

ClarifyPaginatedModel(ClarifyClient, ClarifyResponse) - Constructor for class io.clarify.api.ClarifyPaginatedModel

ClarifyResponse - Class in io.clarify.api

Wraps all of the details of a low-level Clarify SDK response into a single class that can be used to: 1) access the response code 2) a parsed version of the content (Using Resty), and 3) the response content (for your own parsing needs).

ClarifyResponse(JSONResource) - Constructor for class io.clarify.api.ClarifyResponse

Initialize a new instance with the given Resty JSONResource returned by the Resty API

client - Variable in class io.clarify.api.BundleMetadata

client - Variable in class io.clarify.api.ClarifyModel

createBundle(String, URI) - Method in class io.clarify.api.ClarifyClient

Creates a new Clarify Bundle using the Create Bundle REST API.

createBundle(String, URI, Map<String, String>) - Method in class io.clarify.api.ClarifyClient

Creates a new Clarify Bundle using the Create Bundle REST API using a name, initial media URL, and any number of additional fields (as defined by the Clarify Create Bundle API).

D

DEFAULT_VERSION - Static variable in class io.clarify.api.ClarifyClient

delete() - Method in class io.clarify.api.Bundle

Deletes this bundle and all of its related Metadata and Tracks, along with media stored on Clarify systems.

deleteBundle(String) - Method in class io.clarify.api.ClarifyClient

Deletes this bundle by bundleId, all of its related Metadata and Tracks, along with media stored on Clarify systems.

deleteTrack(String) - Method in class io.clarify.api.Bundle

Deletes a track from this bundle.

deleteTrack(String, String) - Method in class io.clarify.api.ClarifyClient

Deletes a track from a specific media Bundle.

F

findBundle(String) - Method in class io.clarify.api.ClarifyClient

Uses the Retrieve Bundle API to return a specific Bundle by the specific bundleId

findBundleByHref(String) - Method in class io.clarify.api.ClarifyClient

Uses the Retrieve Bundle API to return a specific Bundle by the specific relative href path

findMetadata(String) - Method in class io.clarify.api.ClarifyClient

Returns a Bundle's Metadata class, with details on the bundle and any attached user data (if available)

findTrack(String) - Method in class io.clarify.api.Bundle

Returns a specific Track by track number for this media Bundle

findTrackByHref(String) - Method in class io.clarify.api.ClarifyClient

Returns a specific Track by the HREF provided in a JSON response

findTrackForBundle(String, String) - Method in class io.clarify.api.ClarifyClient

Returns a specific Track by track number for a media Bundle

G

getBundleId() - Method in class io.clarify.api.BundleMetadata

getClarifyClient() - Method in class io.clarify.api.ClarifyModel

getClarifyResponse() - Method in class io.clarify.api.ClarifyModel

getId() - Method in class io.clarify.api.Bundle

Attempts to navigate the parsed JSON and return the field "id" in the payload

getId() - Method in class io.clarify.api.BundleTrack

Attempts to navigate the parsed JSON and return the field "id" in the payload

getItemResults() - Method in class io.clarify.api.BundleSearchResults

Returns the item_results array from the search results that provides term results, scores, and matches

getJSONResource() - Method in class io.clarify.api.ClarifyResponse

Returns the underlying Resty JSONResource object, representing the parsed JSON response code See http://beders.github.io/Resty/Resty/Overview.html for more details on the Resty Java API

getJSONValue(String) - Method in class io.clarify.api.ClarifyResponse

Uses the Resty JSONResponse to perform attempt to get a JSON path from the response payload and return it.

getLinkItems() - Method in class io.clarify.api.ClarifyPaginatedModel

Returns items within the _links element of the JSON response.

getLinks() - Method in class io.clarify.api.ClarifyPaginatedModel

Returns a us.monoid.json.JSONObject for the _links element of the JSON response, allowing further exploration by the caller

getMetadata() - Method in class io.clarify.api.Bundle

Returns this media Bundle's Metadata class, with details on the bundle and any attached user data (if available)

getResponseCode() - Method in class io.clarify.api.ClarifyResponse

Returns the response code associated with this Clarify API call

getResponseContent() - Method in class io.clarify.api.ClarifyResponse

Returns the raw JSON content from the response, allowing the caller to parse the JSON response using their own library

H

hasNextPage() - Method in class io.clarify.api.ClarifyPaginatedModel

Determine if there is another page available, or if the returned response represents the last page

I

io.clarify.api - package io.clarify.api

L

listBundles() - Method in class io.clarify.api.ClarifyClient

Retrieves the first page from the List Bundles REST API.

listTracks() - Method in class io.clarify.api.Bundle

Returns the list of Tracks associated to this media Bundle

listTracksForBundle(String) - Method in class io.clarify.api.ClarifyClient

Returns the list of Tracks associated to this media Bundle

N

nextLink() - Method in class io.clarify.api.ClarifyPaginatedModel

nextPage() - Method in class io.clarify.api.BundleList

Attempt to request the next page using the next link from the current page

nextPage() - Method in class io.clarify.api.BundleSearchResults

Attempt to request the next page using the next link from the current page

R

resetData() - Method in class io.clarify.api.BundleMetadata

Delete the metadata of a bundle and set data to {} (empty object.) This is functionally equivalent to an update metadata request with data set to {}.

resetMetadata(String) - Method in class io.clarify.api.ClarifyClient

Delete the metadata of a bundle and set data to {} (empty object.) This is functionally equivalent to an update metadata request with data set to {}.

response - Variable in class io.clarify.api.ClarifyModel

S

SDK_VERSION - Static variable in class io.clarify.api.ClarifyClient

searchBundles(String) - Method in class io.clarify.api.ClarifyClient

Performs a wildcard search for the specific query string provided.

searchBundles(String, Map<String, String>) - Method in class io.clarify.api.ClarifyClient

Performs an advanced search for the specific query string provided using the additional search query parameters provided.

T

toString() - Method in class io.clarify.api.ClarifyModel

U

updateBundle(String, Map<String, String>) - Method in class io.clarify.api.ClarifyClient

Updates an existing Bundle's properties, incrementing the Bundle version number on success.

updateData(String) - Method in class io.clarify.api.BundleMetadata

Updates the user-defined data property of the Bundle's Metadata with the supplied JSON string, then return a refreshed copy (resulting in 2 API calls)

updateMetadata(String, String) - Method in class io.clarify.api.ClarifyClient

Updates the user-defined data property of the Bundle's Metadata with the supplied JSON string, then return a refreshed copy (resulting in 2 API calls)

urlEncodeMap(Map<String, String>) - Method in class io.clarify.api.ClarifyClient

V

version() - Method in class io.clarify.api.ClarifyClient

Returns the default API version

A B C D F G H I L N R S T U V