1. interface
  2. Contentful
  3. \
  4. Core
  5. \
  6. Api
  7. \
  8. ApplicationInterface

ApplicationInterface

interface ApplicationInterface

Methods

string
getApplicationName()

Returns the name of the current application.

bool
isPackagedApplication()

Returns whether the current application is distributed as a Composer package.

string
getApplicationPackageName()

Returns the package name of the current application.

string
getApplicationVersion()

Returns the version of the current application.

Details

at line 23
string getApplicationName()

Returns the name of the current application.

This value must be the one that is sent as part of the "X-Contentful-User-Agent" header to the API.

Return Value

string

at line 30
bool isPackagedApplication()

Returns whether the current application is distributed as a Composer package.

Return Value

bool

at line 39
string getApplicationPackageName()

Returns the package name of the current application.

If the application is not distributed as a package, this method must return an empty string.

Return Value

string

at line 48
string getApplicationVersion()

Returns the version of the current application.

This must return an actual version if the application is not distributed as a Composer package.

Return Value

string