public interface Scene7Service
Scene7Service
provides methods for interacting with the official Scene7 API.Modifier and Type | Field and Description |
---|---|
static int |
CONTAINER
Scene7 specification used in getAssociatedAssets - Array of set and template assets containing the specified asset.
|
static int |
DERIVED
Scene7 specification used in getAssociatedAssets - Array of assets that are derivatives of the specified asset.
|
static int |
GENERATED
Scene7 specification used in getAssociatedAssets - Array of assets that were generated from the specified asset.
|
static int |
GENERATOR
Scene7 specification used in getAssociatedAssets - Array of assets that were used to generate the specified asset.
|
static int |
MEMBER
Scene7 specification used in getAssociatedAssets - Array of assets contained by the specified set or template asset.
|
static int |
OWNER
Scene7 specification used in getAssociatedAssets - Array of assets that own the specified asset.
|
Modifier and Type | Method and Description |
---|---|
String |
deleteAsset(String assetHandle,
S7Config s7Config)
Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
|
String |
deleteFolder(String folderHandle,
S7Config s7Config)
Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
|
String |
getApplicationPropertyHandle(S7Config s7Config)
Returns the application property handle.
|
List<Scene7Asset> |
getAssets(String[] assetHandles,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Returns a
Scene7Asset list, based on a list of asset handles |
Scene7Asset |
getAssociatedAssets(Scene7Asset asset,
S7Config s7Config)
Retrieves the sub-assets and the origiator asset associated with the given asset
|
String |
getCompanyMembership(String userHandle,
String email,
String password,
String region)
Returns a JSON representation of the company membership information provided by Scene7.
|
String |
getFlashTemplatesServer(S7Config s7Config)
Retrieves the server used for serving and manipulating flash templates, depending on the Scene7 configuration.
|
String |
getFolderHandle(String cqFolderPath,
S7Config s7Config)
Returns s7 folder handle for the associated cq folder
|
Scene7Folder |
getFolderTree(String folderPath,
int depth,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Returns a
Scene7Folder holding a tree structure |
String |
getFxgServer(S7Config s7Config)
Retrieves the server handling FXG rendering.
|
List<String> |
getImagePresets(S7Config s7Config)
Returns a list of Scene7 image preset names for the given
S7Config |
List<String> |
getJobLogDetails(String jobHandle,
S7Config s7Config)
Returns a list of Scene7 asset handles(Strings) for the given job handle
|
ArrayList<UploadJobDetail> |
getMultiFileJobLogDetails(String jobHandle,
S7Config s7Config)
Returns an Arraylist of job details objects
|
List<Scene7PropertySet> |
getPropertySets(String typeHandle,
S7Config s7Config)
Returns the video encoder preset type handle.
|
String |
getPublishServer(S7Config s7Config)
Returns the domain name of the S7 publish server
|
String |
getUserHandle(String email,
String password,
String region)
Returns a unique user handle from Scene7.
|
String |
getVideoEncoderPresetTypeHandle(S7Config s7Config)
Returns the video encoder preset type handle.
|
boolean |
isJobActiveByJobHandle(String jobHandle,
S7Config s7Config) |
boolean |
isJobActiveByOriginalName(String originalName,
S7Config s7Config) |
List<Scene7Asset> |
searchAssets(String folder,
Boolean includeSubfolders,
Boolean published,
String[] assetTypes,
String[] assetSubTypes,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Retrieves a list of
Scene7Asset s from the Scene7 server. |
List<Scene7Asset> |
searchAssetsByMetadata(String folder,
Boolean includeSubfolders,
String[] assetTypes,
String[] assetSubTypes,
Boolean published,
MetadataCondition[] conditions,
S7Config s7Config)
Returns a DOM list with search results (from metadata)
|
static final int CONTAINER
static final int MEMBER
static final int OWNER
static final int DERIVED
static final int GENERATOR
static final int GENERATED
String getPublishServer(S7Config s7Config)
s7Config
- String getApplicationPropertyHandle(S7Config s7Config)
s7Config
- the Scene7 configurationString getVideoEncoderPresetTypeHandle(S7Config s7Config)
s7Config
- the Scene7 configurationList<Scene7PropertySet> getPropertySets(String typeHandle, S7Config s7Config)
typeHandle
- - the type handles7Config
- the Scene7 configurationString getUserHandle(String email, String password, String region)
email
- E-Mail addresspassword
- Passwordregion
- Region of the Scene7 serviceString getCompanyMembership(String userHandle, String email, String password, String region)
For example:
{
handle: 'jlkj98',
name: 'Acme Ltd.',
rootPath: '/MyAssets'
}
userHandle
- Unique user handleemail
- E-Mail addresspassword
- Passwordregion
- Region of the Scene7 serviceScene7Folder getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Folder
holding a tree structurefolderPath
- - the top folder of the request - does not need to be the root.depth
- - depth of the returned folder tree.responseFields
- - fields to be filled in for each node in the treeexcludeFields
- - fields to be excluded in each node of the trees7Config
- Scene7Folder
object containing the requested folder structureString getFolderHandle(String cqFolderPath, S7Config s7Config)
cqFolderPath
- - the path the target cq folder targeted in the s7 folder organizations7Config
- String deleteFolder(String folderHandle, S7Config s7Config)
folderHandle
- - folder to be deleteds7Config
- - s7 config based on cloud service config info.String deleteAsset(String assetHandle, S7Config s7Config)
assetHandle
- - asset to be deleteds7Config
- - s7 config based on cloud service config info.List<Scene7Asset> searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config)
folder
- - all matched assets will be in this folderincludeSubfolders
- - whether to recursively search for assetsassetTypes
- - all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchpublished
- - whether the matched assets must be marked for publish (only marked - not necessarily actually published)conditions
- - metadata conditions for searchs7Config
- List<Scene7Asset> getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Asset
list, based on a list of asset handlesassetHandles
- - the assets to retrieveresponseFields
- - fields to be filled in for each node in the treeexcludeFields
- - fields to be excluded in each node of the trees7Config
- Scene7Asset
listArrayList<UploadJobDetail> getMultiFileJobLogDetails(String jobHandle, S7Config s7Config)
jobHandle
- - the handle for the job to get details.s7Config
- boolean isJobActiveByJobHandle(String jobHandle, S7Config s7Config)
jobHandle
- of the jobs7Config
- true
if active job with this jobHandle or orginalName is active, false
otherwiseboolean isJobActiveByOriginalName(String originalName, S7Config s7Config)
originalName
- of the jobs7Config
- true
if active job with this jobHandle or orginalName is active, false
otherwiseList<String> getJobLogDetails(String jobHandle, S7Config s7Config)
jobHandle
- - the handle for the job to get details.s7Config
- List<String> getImagePresets(S7Config s7Config)
S7Config
s7Config
- String getFlashTemplatesServer(S7Config s7Config)
s7Config
- the Scene7 configurationList<Scene7Asset> searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, S7Config s7Config)
Scene7Asset
s from the Scene7 server.folder
- the folder from which the assets are retrievedincludeSubfolders
- whether to recursively search for assets in sub-folders of the folder where the search is performedpublished
- whether the matched assets must be marked for publish (only marked - not necessarily actually published)assetTypes
- all matched assets will be one of these typesassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- the response fields that should be used to populate the Scene7Asset
's attributesexcludeFields
- fields to be excluded from the responses7Config
- the Scene7 configurationScene7Asset getAssociatedAssets(Scene7Asset asset, S7Config s7Config)
asset
- - the asset to get the sub-assets and generator froms7Config
- - the Scene7 configurationScene7Asset
object updated with the sub-assets and the originator asset"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"