Click or drag to resize

IContentStoreGetStartingUser Method


Gets a starting User object to open a session.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
IReadonlyUser GetStartingUser(
	string userId,
	IPAddress visitorIp = null
)

Parameters

userId
Type: SystemString
The unique ID of the user to retrieve
visitorIp (Optional)
Type: System.NetIPAddress

[Missing <param name="visitorIp"/> documentation for "M:Ingeniux.CMS.IContentStore.GetStartingUser(System.String,System.Net.IPAddress)"]

Return Value

Type: IReadonlyUser
The read-only User object. This User object is only for creating sessions; you cannot make changes to this object.
Exceptions
ExceptionCondition
InvalidDataExceptionUser doesn't exist in ContentStore.
Remarks
It is good idea to keep this object around, since all session openings need a starting user, and retrieving it every time is will waste of bandwidth.
See Also