Docs / Dashboard / UI Plugins Development / Plugins API Reference / FlotiqApiClient

FlotiqApiClient

class FlotiqApiClient

Api client

Properties

Name	Type	Description
contenttypename	ContentTypeAPIClient.<contenttypename>	api client for given content type
contenttypename.get	function	get a content object, passing id as an argument. Will throw an error witout access to the content type.
contenttypename.getVersions	function	get a content object versions, passing id as an argument. Will throw an error witout access to the content type.
contenttypename.getVersion	function	get a content object version, passing id and version as arguments. Will throw an error witout access to the content type.
contenttypename.list	function	list content objects, passing query params as an first argument Will throw an error witout access to the content type.
contenttypename.post	function	create content object, passing object as an argument Will throw an error witout access to the content type.
contenttypename.put	function	update content object, passing id and object as arguments Will throw an error witout access to the content type.
contenttypename.delete	function	delete content object, passing id as an argument Will throw an error witout access to the content type.
contenttypename.getContentType	function	get definition for given content type Will throw an error witout access to the content type.
contenttypename.patch	function	partialy update content object, passing id and object as arguments Will throw an error witout access to the content type.
getContentTypes	getContentTypes	Generate url for media. Use width/height params to generate url for resized image
getMediaUrl	getMediaUrl	Generate url for media. Use width/height params to generate url for resized image

function getContentTypes

Generate url for media. Use width/height params to generate url for resized image

Returns - Promise.<ContentTypesResponse>
Api response containing list of content types

Parameters

Name	Type	Description
params	object	query parameters for content types list (e.g. limit, page etc)

function getMediaUrl

Generate url for media. Use width/height params to generate url for resized image

Returns - string
media url

Parameters

Name	Type	Description
mediaContentObject	object
width	number
height	number