Interface IConnector

Namespace: DotNetNuke.Services.Connections
Assembly: DotNetNuke.dll
Syntax
public interface IConnector

Properties

| Improve this Doc View Source

DisplayName

Gets or sets display name of the connector.

Declaration
string DisplayName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IconUrl

Gets icon URL of the connector.

Declaration
string IconUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Id

Gets or sets the ID of the connector. It is required if SupportsMultiple is true.

Declaration
string Id { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsEngageConnector

Gets a value indicating whether it is an Evoq: Engage connector or not.

Declaration
bool IsEngageConnector { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Name

Gets unique name of the connector. It is used to distinguish between different types of connectors.

Declaration
string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PluginFolder

Gets plugins folder for the connector.

Declaration
string PluginFolder { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SupportsMultiple

Gets a value indicating whether determines whether this connector supports multiple connections or not.

Declaration
bool SupportsMultiple { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Type

Gets category of the connector. It can be used to sort similar type resources.

Declaration
ConnectorCategories Type { get; }
Property Value
Type Description
ConnectorCategories

Methods

| Improve this Doc View Source

DeleteConnector(Int32)

Delete a connector. This is used only if SupportsMultiple is true.

Declaration
void DeleteConnector(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
| Improve this Doc View Source

GetConfig(Int32)

Get the connector configuration.

Declaration
IDictionary<string, string> GetConfig(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
Returns
Type Description
IDictionary<System.String, System.String>

A dictionary of configuration values.
| Improve this Doc View Source

GetConnectors(Int32)

Get all the connectors of a particular type.

Declaration
IEnumerable<IConnector> GetConnectors(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
Returns
Type Description
IEnumerable<IConnector>

A sequence of IConnector instances.
| Improve this Doc View Source

HasConfig(Int32)

Checks if the connector has been configured or not.

Declaration
bool HasConfig(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
Returns
Type Description
System.Boolean

true if the portal has been configured, otherwise false.
| Improve this Doc View Source

SaveConfig(Int32, IDictionary<String, String>, ref Boolean, out String)

Save the connector configuration. This will work as both edit and new if SupportsMultiple is true.

Declaration
bool SaveConfig(int portalId, IDictionary<string, string> values, ref bool validated, out string customErrorMessage)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
IDictionary<System.String, System.String> values

The new configuration values.
System.Boolean validated

true if the configuration values were able to be validated, otherwise false.
System.String customErrorMessage

An error message, or to use a default error message (when returning false).
Returns
Type Description
System.Boolean

true if the configuration were successfully saved, otherwise false.

Extension Methods