Class APActorEndpoints
- Namespace
- ActivityPub.Types.AS
- Assembly
- ActivityPub.Types.dll
A json object which maps additional (typically server/domain-wide) endpoints which may be useful for an actor.
public class APActorEndpoints : ASType, IASModel<ASType, ASTypeEntity>, IASModel<ASType>, IASModel<APActorEndpoints, APActorEndpointsEntity, ASType>, IASModel<APActorEndpoints, APActorEndpointsEntity>, IASModel<APActorEndpoints>- Inheritance
-
APActorEndpoints
- Implements
- Inherited Members
Constructors
APActorEndpoints()
Constructs a new instance and attaches it to a new, empty type graph.
public APActorEndpoints()APActorEndpoints(ASType)
public APActorEndpoints(ASType existingGraph)Parameters
existingGraphASType
APActorEndpoints(TypeMap, APActorEndpointsEntity?)
public APActorEndpoints(TypeMap typeMap, APActorEndpointsEntity? entity)Parameters
typeMapTypeMapentityAPActorEndpointsEntity
APActorEndpoints(TypeMap, bool)
Constructs a new instance from an existing type graph. The existing graph is either extended or wrapped, depending on the value of
isExtendingpublic APActorEndpoints(TypeMap typeMap, bool isExtending = true)Parameters
Remarks
All overrides MUST call this using
base(typeMap, false)Exceptions
- InvalidOperationException
If
is true and the entity type already exists in the graphextendGraph- InvalidOperationException
If
is true and the entity requires another entity that is missing from the graphextendGraph- InvalidCastException
If
is false and the object is not of typeextendGraphTEntity
- See Also
Properties
Entity
private APActorEndpointsEntity Entity { get; }Property Value
OAuthAuthorizationEndpoint
If OAuth 2.0 bearer tokens [RFC6749] [RFC6750] are being used for authenticating client to server interactions, this endpoint specifies a URI at which a browser-authenticated user may obtain a new authorization grant.
[JsonPropertyName("oauthAuthorizationEndpoint")]
public ASLink? OAuthAuthorizationEndpoint { get; set; }Property Value
OAuthTokenEndpoint
If OAuth 2.0 bearer tokens [RFC6749] [RFC6750] are being used for authenticating client to server interactions, this endpoint specifies a URI at which a client may acquire an access token.
[JsonPropertyName("oauthTokenEndpoint")]
public ASLink? OAuthTokenEndpoint { get; set; }Property Value
ProvideClientKey
If Linked Data Signatures and HTTP Signatures are being used for authentication and authorization, this endpoint specifies a URI at which browser-authenticated users may authorize a client's public key for client to server interactions.
[JsonPropertyName("provideClientKey")]
public ASLink? ProvideClientKey { get; set; }Property Value
ProxyUrl
Endpoint URI so this actor's clients may access remote ActivityStreams objects which require authentication to access. To use this endpoint, the client posts an x-www-form-urlencoded id parameter with the value being the id of the requested ActivityStreams object.
[JsonPropertyName("proxyUrl")]
public ASLink? ProxyUrl { get; set; }Property Value
SharedInbox
An optional endpoint used for wide delivery of publicly addressed activities and activities sent to followers. SharedInbox endpoints SHOULD also be publicly readable OrderedCollection objects containing objects addressed to the Public special collection. Reading from the sharedInbox endpoint MUST NOT present objects which are not addressed to the Public endpoint.
[JsonPropertyName("sharedInbox")]
public ASLink? SharedInbox { get; set; }Property Value
SignClientKey
If Linked Data Signatures and HTTP Signatures are being used for authentication and authorization, this endpoint specifies a URI at which a client key may be signed by the actor's key for a time window to act on behalf of the actor in interacting with foreign servers.
[JsonPropertyName("signClientKey")]
public ASLink? SignClientKey { get; set; }Property Value
Explicit Interface Implementations
IASModel<APActorEndpoints>.FromGraph(TypeMap)
Constructs an instance from this type from a pre-populated type graph. The provided TypeMap instance is guaranteed to include an instance of type EntityType.
static APActorEndpoints IASModel<APActorEndpoints>.FromGraph(TypeMap typeMap)Parameters
typeMapTypeMap