ePages 7.47.0 - DE_EPAGES/AppStore/API/Object/ScriptTagAppClient.pm

Package DE_EPAGES::AppStore::API::Object::ScriptTagAppClient

Client for OAuth access token operations for the script-tag ressource.

Base
DE_EPAGES::AppStore::API::Object::DeveloperAppsClient

Functions

addScriptTag
create
createApp
deleteApp
deleteScriptTag
existsApp
getAllScriptTags
getApp
getScriptTag
isScriptTagPresent
new

addScriptTag

Adds a script tag to the current shop.

Syntax
$ScriptTagAppClient->addScriptTag($ScriptUrl);
Input
$ScriptUrl (string)
Url of the related script tag

create

Factory method for a ScriptTagAppClient object. Initializes based on the current configuration.

Syntax
$ScriptTagAppClient = DE_EPAGES::AppStore::API::Object::ScriptTagAppClient->create($hArgs);
Return
$ScriptTagAppClient (DE_EPAGES::AppStore::API::Object::ScriptTagAppClient)
ScriptTagAppClient object

createApp

Creates the EpagesUIScriptTags app for the current shop.

Syntax
$ScriptTagApp = $ScriptTagAppClient->createApp();
Return
$ScriptTagsApp (ref.hash)
Unity script-tags app

deleteApp

Deletes the EpagesUIScriptTags app for the current shop.

Syntax
$ScriptTagAppClient->deleteApp();

deleteScriptTag

Deletes a script tag from the current shop.

Syntax
$ScriptTagAppClient->deleteScriptTag($ScriptUrl);
Input
$ScriptUrl (string)
Url of the related script tag

existsApp

Returns true, if the EpagesUIScriptTags app is installed for the current shop, false if not.

Syntax
$ExistsApp = $ScriptTagAppClient->existsApp();
Return
$ExistsApp (boolean)
exists app

getAllScriptTags

Returns all script-tags related to the app.

Syntax
$ScriptTagAppClient->getAllScriptTags();
Return
$hScriptTags (ref.array)
script-tags

getApp

Returns the EpagesUIScriptTags app of the current shop.

Syntax
$ScriptTagApp = $ScriptTagAppClient->getApp();
Return
$ScriptTagsApp (ref.hash)
Unity script-tags app

getScriptTag

Returns the script-tag of the given Url if any.

Syntax
$ScriptTagAppClient->getScriptTag($ScriptUrl);
Input
$ScriptUrl (string)
Url of the related script tag
Return
$hScriptTag (ref.hash)
script-tag

isScriptTagPresent

Check if a given Url has been already added to the script-tags.

Syntax
$ScriptTagAppClient->isScriptTagPresent($ScriptUrl);
Input
$ScriptUrl (string)
Url of the related script tag
Return
$IsScriptTagPresent (boolean)
is script-tag prensent

new

Instanciates a new ScriptTagAppClient.

Syntax
DE_EPAGES::AppStore::API::Object::ScriptTagAppClient->new( %args );
Input
%args (hash)
Input arguments. Possible keys.
  • Shop - shop object
  • ScriptTagsUriTemplate -
  • ScriptTagTemplate -
  • MyScriptTagsUriTemplate - ... - DE_EPAGES::EPagesJ::API::Object::UriTemplate
  • LogCategory - category for commlogger. Defaults to "OAuth" - string
Return
OAuthTokenClient (object)
new instance of OAuthTokenClient