TourTips In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:55 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:55

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ITourTips>() and is defined in Telligent.Evolution.Platform.dll

Methods

string GenerateKey(string message);

Generates a unique key for a given tip

Parameters

Name	Type	Description	Required	Default	Options
message	`string`	Tip message	Required

Return Type

string

ApiList<TourTip> List(IList<string> tipKeys);

Lists tour tips with read state for the accessing user and requested tip keys

Parameters

Name	Type	Description	Required	Default	Options
tipKeys	`IList<string>`	Tip keys	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[TourTip In-Process API Supplementary Type|TourTip]]>

TourTip Mark(string tipKey, bool asRead);

Marks a tour tip as read or unread for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
tipKey	`string`	Tip key	Required
asRead	`bool`	Read state	Required

Return Type

[[TourTip In-Process API Supplementary Type|TourTip]]