Back to API Home

The IntegrationHelper type exposes the following members.

Methods

  NameDescription
Public methodStatic memberClearCurrentSessionId
Clears the ID of the current session.
Public methodStatic memberDeleteBookmark
Deletes the specified bookmark.
Public methodStatic memberDuplicateProject(Guid, Guid)
Copies items from a specified project into an existing project.
Public methodStatic memberDuplicateProject(Guid, String)
Copies all items from a specified project into a new project.
Public methodStatic memberGetBookmark
Gets the bookmark from the specified id.
Public methodStatic memberGetClientId
Gets the client ID (if any) associated with a session. An exception is thrown if the session doesn't exist.
Public methodStatic memberGetDashboardImage(Guid, Guid)
Gets the dashboard image by calling the Image Creation Service.
Public methodStatic memberGetDashboardImage(Guid, Guid, ParameterInfoCollection)
Gets the dashboard image by calling the Image Creation Service. This method is not recommended if there are more than 5 parameters present. Instead, the GetDashboardImageFromBookmark(Guid, Guid, Boolean) call should be used.
Public methodStatic memberGetDashboardImage(Guid, Guid, ParameterInfoCollection, Boolean)
Gets the dashboard image by calling the Image Creation Service. This method is not recommended if there are more than 5 parameters present. Instead, the GetDashboardImageFromBookmark(Guid, Guid, Boolean) call should be used.
Public methodStatic memberGetDashboardImageFromBookmark
Gets the dashboard image from a bookmark by calling the Image Creation Service. This method is preferred when there are more than 5 Parameters being used for a call.
Public methodStatic memberGetLinkUri(Uri, Guid, ViewerContentItemType, ParameterInfoCollection)
Generates a uri link that can be used to view a Dundas Dashboard object.
Public methodStatic memberGetLinkUri(Uri, Guid, ViewerContentItemType, ParameterInfoCollection, Guid)
Generates a uri link that can be used to view a Dundas Dashboard object.
Public methodStatic memberGetLinkUri(Uri, Guid, ViewerContentItemType, ParameterInfoCollection, Nullable<(Of <<'(Guid>)>>), Boolean)
Generates a uri link that can be used to view a Dundas Dashboard object.
Public methodStatic memberGetLocalLoginToken(IEnumerable<(Of <<'(ILoginCredential>)>>))
Validates the credentials of a local user and returns a token if the credentials represent a valid Dundas Dashboard user. Otherwise, throws an exception.
Public methodStatic memberGetLocalLoginToken(String, String)
Validates the username and password of a local user and returns a token if the credentials represent a valid Dundas Dashboard user. Otherwise, throws an exception.
Public methodStatic memberGetSessionCustomAttribute
Gets the session custom attribute values.
Public methodStatic memberGetShortLinkId
Gets the key that can be used as as a short link to a dashboard and its parameters.
Public methodStatic memberGetViewableDashboardIds
Gets the IDs of the dashboards to which a user has at least read access.
Public methodStatic memberGetWindowsLoginToken
Validates the credentials of a Windows user and returns a token if the credentials represent a valid Dundas Dashboard user. Otherwise, throws an exception.
Public methodStatic memberInvalidateDataCache
Invalidates the data cache.
Public methodStatic memberLogin(Guid, Guid, Boolean)
Logs in a user identified by a previously created login token.
Public methodStatic memberLogin(Guid, Guid, String, Boolean)
Logs in a user identified by a previously created login token.
Public methodStatic memberLoginLocal(String, String)
Logs in a local user.
Public methodStatic memberLoginLocal(Collection<(Of <<'(ILoginCredential>)>>), Boolean)
Logs in a local user.
Public methodStatic memberLoginLocal(String, String, Boolean)
Logs in a local user.
Public methodStatic memberLoginLocal(Collection<(Of <<'(ILoginCredential>)>>), String, Boolean)
Logs in a local user.
Public methodStatic memberLoginLocal(String, String, String, Boolean)
Logs in a local user.
Public methodStatic memberLoginLocalChangePassword(String, String, String)
Logs in a local user and changes their password.
Public methodStatic memberLoginLocalChangePassword(String, String, String, Boolean)
Logs in a local user and changes their password.
Public methodStatic memberLoginWindows()()()()
Logs in a Windows user.
Public methodStatic memberLoginWindows(Boolean)
Logs in a Windows user.
Public methodStatic memberLoginWindows(Guid)
Logs in a Windows user.
Public methodStatic memberLoginWindows(Guid, Boolean)
Logs in a Windows user.
Public methodStatic memberLoginWindows(String, Guid, Boolean)
Logs in a Windows user.
Public methodStatic memberLoginWindows(String, String, String, Boolean, String, Nullable<(Of <<'(Guid>)>>))
Public methodStatic memberLogout
Logs out a user.
Public methodStatic memberPing
Pings the Dundas Dashboard server.
Public methodStatic memberSaveBookmark
Saves the given bookmark.
Public methodStatic memberSetCurrentSessionId
Sets the ID of the current session.
Public methodStatic memberSetSessionCustomAttribute
Sets the session custom attribute values.
Public methodStatic memberUnsubscribe
Unsubscribes a notification.

Properties

  NameDescription
Public propertyStatic memberServerUri
Gets or sets the base URI of the Dundas Dashboard server.
Public propertyStatic memberTimeout
Gets or sets the timeout for communicating with the Dundas.Dashboard server.

See Also