@sitecore-cloudsdk/personalize/server

addPersonalize

Version:

Type	Function
Import path	`@sitecore-cloudsdk/personalize/server`

Used as a method by the CloudSDK function to initialize the personalize package.

Signature

export function addPersonalize(
  settings?: ServerSettings
): CloudSDKServerInitializer

Parameters

Name	Type	Description
`settings`	`ServerSettings`	Optional. Initialization settings for the package.

Name

Type

Description

settings

ServerSettings

Optional.

Initialization settings for the package.

`ServerSettings` properties

Name	Type	Description	Value
`enablePersonalizeCookie`	`boolean`	Optional. Whether to set the `sc_cid_personalize` cookie from the server side. If using only the `server` module of the `personalize` package, set to `true`. If using both the `browser` and the `server` modules of the `personalize` package, set `enablePersonalizeCookie` to `true` either on the browser or the server, and set to `false` on the other. If `enableServerCookie` is `false`, `enablePersonalizeCookie` will not be set. Default: `false`.	`true`

Name

Type

Description

Value

enablePersonalizeCookie

boolean

Optional.

Whether to set the sc_cid_personalize cookie from the server side.

If using only the server module of the personalize package, set to true.

If using both the browser and the server modules of the personalize package, set enablePersonalizeCookie to true either on the browser or the server, and set to false on the other.

If enableServerCookie is false, enablePersonalizeCookie will not be set.

Default: false.

true

Return value

Initializes the personalize package and returns an instance of CloudSDKServerInitializer.

Examples

See code examples in CloudSDK.