getPortalUrls

Function

get portal URLs (home, API, data, and thumbnail) for an item

get portal URLs (home, API, data, and thumbnail) for an item

  • getPortalUrls(item: IItem, requestOptions: IHubRequestOptions) : {
    portalApi:
    string
    portalData:
    string
    portalHome:
    string
    thumbnail:
    string
    }

Parameters

Parameter Type Default Notes
item Required IItem

Item

requestOptions Required IHubRequestOptions

Request options

Available requestOptions

Property Type Notes
authentication Optional UserSession
hubApiUrl Optional string
isPortal Optional boolean
portalSelf Optional IHubRequestOptionsPortalSelf

Returns

a hash with the portal URLs

{
portalApi:
string
portalData:
string
portalHome:
string
thumbnail:
string
}

Function defined in common/src/content/compose.ts:341