Virtual Happy Hour canceled for Friday May 31st.

Try our conversational search powered by Generative AI!

AI OnAI Off

Class RemoteSite

Represents a registered remote EPiServer CMS site.

Inheritance
System.Object
RemoteSite
Implements
System.Net.ICredentials
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.DataAbstraction
Assembly: EPiServer.dll
Version: 7.19.2
Syntax
[Obsolete("Remote Sites is no longer supported, it was a concept before Content/Page Providers was introduced")]
public class RemoteSite : ICredentials

Constructors

RemoteSite()

Initializes a new instance of the RemoteSite class.

Declaration
public RemoteSite()

Properties

AllowUrlLookup

Gets or sets a value indicating whether referencing the RemoteSite by URL is allowed.

Declaration
public bool AllowUrlLookup { get; set; }
Property Value
Type Description
System.Boolean

true if URL references to the RemoteSite is allowed; otherwise, false.

Credentials

Gets the credentials used for accessing the remote site.

Declaration
public NetworkCredential Credentials { get; }
Property Value
Type Description
System.Net.NetworkCredential

DataFactoryUrl

Gets the URL to the DataFactory web service of the remote site.

Declaration
public string DataFactoryUrl { get; }
Property Value
Type Description
System.String

The data factory URL.

Domain

Gets or sets the domain used for accessing the remote site (see Credentials).

Declaration
public string Domain { get; set; }
Property Value
Type Description
System.String

The domain.

ID

Gets or sets the ID.

Declaration
public int ID { get; set; }
Property Value
Type Description
System.Int32

The ID.

IsTrusted

Gets or sets a value indicating whether this instance is trusted.

Declaration
public bool IsTrusted { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is trusted; otherwise, false.

Name

Gets or sets the name.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name.

Password

Gets or sets the password used for accessing the remote site (see Credentials).

Declaration
public string Password { get; set; }
Property Value
Type Description
System.String

The password.

RemoteSites

Gets the registered remote sites.

Declaration
public static RemoteSiteDictionary RemoteSites { get; }
Property Value
Type Description
RemoteSiteDictionary

A RemoteSiteDictionary containing the registered remote sites, where the registration name is the dictionary key.

Url

Gets or sets the URL.

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

The URL.

UserName

Gets or sets the name of the user used for accessing the remote site (see Credentials).

Declaration
public string UserName { get; set; }
Property Value
Type Description
System.String

The name of the user.

Methods

Delete()

Deletes this RemoteSite.

Declaration
public void Delete()

GetCredential(Uri, String)

Returns a System.Net.NetworkCredential object that is associated with the specified URI, and authentication type.

Declaration
public NetworkCredential GetCredential(Uri uri, string authType)
Parameters
Type Name Description
System.Uri uri

The System.Uri that the client is providing authentication for.
System.String authType

The type of authentication, as defined in the System.Net.IAuthenticationModule.AuthenticationType property.
Returns
Type Description
System.Net.NetworkCredential

The System.Net.NetworkCredential that is associated with the specified URI and authentication type, or, if no credentials are available, null.

InternalLoad()

Loads a dictionary of the registered remote sites.

Declaration
protected static RemoteSiteDictionary InternalLoad()
Returns
Type Description
RemoteSiteDictionary

A RemoteSiteDictionary containing the registered remote sites, where the registration name is the dictionary key.

List()

Retrieves a list of all registered remote sites.

Declaration
public static ICollection<RemoteSite> List()
Returns
Type Description
System.Collections.Generic.ICollection<RemoteSite>

A System.Collections.Generic.ICollection<T>

Load(Int32)

Loads a RemoteSite with the specified ID.

Declaration
public static RemoteSite Load(int id)
Parameters
Type Name Description
System.Int32 id

The id.
Returns
Type Description
RemoteSite

Load(String)

Loads a RemoteSite with the specified registered name.

Declaration
public static RemoteSite Load(string name)
Parameters
Type Name Description
System.String name

The name.
Returns
Type Description
RemoteSite

A RemoteSite.

Ping()

Pings this RemoteSite.

Declaration
public bool Ping()
Returns
Type Description
System.Boolean

true if the ping was successful; otherwise false.

Ping(String)

Pings the remote site with the specified name.

Declaration
public static bool Ping(string remoteSiteName)
Parameters
Type Name Description
System.String remoteSiteName

Name of the remote site.
Returns
Type Description
System.Boolean

true if the ping was successful; otherwise false.

Save()

Saves this RemoteSite.

Declaration
public void Save()

Implements

System.Net.ICredentials

Extension Methods