Class EndPoint

Inheritance
System.Object
EndPoint
AUSEndPoint
QAEndPoint
USAEndPoint
Namespace: Appearition.Internal.EndPoints
Assembly: Appearition.SDK.dll
Syntax
[Serializable]
public class EndPoint

Constructors

EndPoint()

Declaration
public EndPoint()

EndPoint(String, String, String, String)

Creates a new end point ApiData. A help page URL can be provided. If none, the default help page URL will be used. It can be accessed via the property GetHelpPageURL.

Declaration
public EndPoint(string newDisplayName, string newEndPointURL, string newPortalURL, string helpPageURLOverride = "")
Parameters
Type Name Description
System.String newDisplayName

New display name.
System.String newEndPointURL

New end point UR.
System.String newPortalURL

New portal UR.
System.String helpPageURLOverride

Properties

customHelpPageURL

URL to the help page, if any.

Declaration
protected virtual string customHelpPageURL { get; set; }
Property Value
Type Description
System.String

The help page UR.

displayName

Endpoint name that can be used for display purposes.

Declaration
public virtual string displayName { get; protected set; }
Property Value
Type Description
System.String

The display name.

endPointURL

URL to the end point, which should be used for requests.

Declaration
public virtual string endPointURL { get; protected set; }
Property Value
Type Description
System.String

The end point UR.

portalURL

URL to the web portal of this end point.

Declaration
public virtual string portalURL { get; protected set; }
Property Value
Type Description
System.String

The portal UR.

Methods

GetHelpPageURL(String)

Gets the URL to the webpage which should contain a help guide. This link will be generated using the portal URL and the channel name, but can be overrode in the constructor.

Declaration
public string GetHelpPageURL(string channelName = "")
Parameters
Type Name Description
System.String channelName

Channel name.
Returns
Type Description
System.String

Extension Methods