Copied!

BrandContextServiceInterface

BrandContextServiceInterface.php : 22
Interface

Methods

publiccreateBrandContext()

BrandContextServiceInterface.php : 55
public createBrandContext(BrandContextCreateStruct $createStruct) : BrandContextInterface

Parameters

Name Type Default value Description
$createStruct BrandContextCreateStruct - -

Return values

BrandContextInterface

Tags
Throws
NotFoundException
Throws
ValidationFailedException
Throws
InvalidArgumentException
Throws
InvalidArgumentValue
Throws
UnauthorizedException

publicdeleteBrandContext()

BrandContextServiceInterface.php : 77
public deleteBrandContext(BrandContextInterface $brandContext) : void

Parameters

Name Type Default value Description
$brandContext BrandContextInterface - -
Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
UnauthorizedException

publicdeleteBrandContextTranslation()

BrandContextServiceInterface.php : 83
public deleteBrandContextTranslation(BrandContextInterface $brandContext, string $languageCode) : void

Parameters

Name Type Default value Description
$brandContext BrandContextInterface - -
$languageCode string - -
Tags
Throws
NotFoundException
Throws
UnauthorizedException

publicfindBrandContexts()

BrandContextServiceInterface.php : 43
public findBrandContexts([BrandContextQuery|null $query = null ][, iterable<string|int, string>|null $prioritizedLanguages = null ]) : BrandContextCollectionInterface

Parameters

Name Type Default value Description
$query BrandContextQuery|null null -
$prioritizedLanguages iterable<string|int, string>|null null -

Return values

BrandContextCollectionInterface

Tags
Throws
InvalidArgumentException
Throws
ValidationFailedException
Throws
NotFoundException

publicgetBrandContext()

BrandContextServiceInterface.php : 31
public getBrandContext(string $identifier[, iterable<string|int, string>|null $prioritizedLanguages = null ]) : BrandContextInterface

Parameters

Name Type Default value Description
$identifier string - -
$prioritizedLanguages iterable<string|int, string>|null null -

Return values

BrandContextInterface

Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
UnauthorizedException

publicnewBrandContextCreateStruct()

BrandContextServiceInterface.php : 57
public newBrandContextCreateStruct(string $identifier) : BrandContextCreateStruct

Parameters

Name Type Default value Description
$identifier string - -

Return values

BrandContextCreateStruct

publicnewBrandContextUpdateStruct()

BrandContextServiceInterface.php : 59
public newBrandContextUpdateStruct(BrandContextInterface $brandContext) : BrandContextUpdateStruct

Parameters

Name Type Default value Description
$brandContext BrandContextInterface - -

Return values

BrandContextUpdateStruct

publicupdateBrandContext()

BrandContextServiceInterface.php : 67
public updateBrandContext(BrandContextInterface $brandContext, BrandContextUpdateStruct $updateStruct) : BrandContextInterface

Parameters

Name Type Default value Description
$brandContext BrandContextInterface - -
$updateStruct BrandContextUpdateStruct - -

Return values

BrandContextInterface

Tags
Throws
InvalidArgumentException
Throws
NotFoundException
Throws
ValidationFailedException
Throws
UnauthorizedException