Pds (FSharp.ATProto) | FSharp.ATProto

FSharp.ATProto

Pds Module

Namespace: FSharp.ATProto.Pds
Assembly: FSharp.ATProto.Pds.dll

Personal Data Server for the AT Protocol.

Functions and values

Function or value	Description
`configure builder` Full Usage: `configure builder` Parameters: builder : `PdsBuilder` Returns: `WebApplication`	Build and configure a WebApplication with all PDS endpoints. builder : `PdsBuilder` Returns: `WebApplication`
`create hostname` Full Usage: `create hostname` Parameters: hostname : `string` Returns: `PdsBuilder`	Create a PDS builder for the given hostname. hostname : `string` Returns: `PdsBuilder`
`createUser pds handle password` Full Usage: `createUser pds handle password` Parameters: pds : `RunningPds` handle : `string` password : `string` Returns: `Task<Result<AtpAgent, XrpcError>>`	Create a new account on a running PDS and return an authenticated AtpAgent. pds : `RunningPds` handle : `string` password : `string` Returns: `Task<Result<AtpAgent, XrpcError>>`
`mapEndpoints builder app` Full Usage: `mapEndpoints builder app` Parameters: builder : `PdsBuilder` app : `WebApplication` Returns: `WebApplication`	Map all PDS XRPC endpoints onto an existing WebApplication. builder : `PdsBuilder` app : `WebApplication` Returns: `WebApplication`
`onAccountCreated handler builder` Full Usage: `onAccountCreated handler builder` Parameters: handler : `AccountCreatedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`	Register a handler called when a new account is created. handler : `AccountCreatedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`
`onRecordCreated handler builder` Full Usage: `onRecordCreated handler builder` Parameters: handler : `RecordCreatedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`	Register a handler called when a record is created. handler : `RecordCreatedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`
`onRecordDeleted handler builder` Full Usage: `onRecordDeleted handler builder` Parameters: handler : `RecordDeletedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`	Register a handler called when a record is deleted. handler : `RecordDeletedEvent -> unit` builder : `PdsBuilder` Returns: `PdsBuilder`
`run hostname port` Full Usage: `run hostname port` Parameters: hostname : `string` port : `int`	Configure and immediately run the PDS (blocking). hostname : `string` port : `int`
`start builder` Full Usage: `start builder` Parameters: builder : `PdsBuilder` Returns: `Task<RunningPds>`	Start a PDS and return a RunningPds for programmatic interaction. builder : `PdsBuilder` Returns: `Task<RunningPds>`
`stop pds` Full Usage: `stop pds` Parameters: pds : `RunningPds` Returns: `Task<unit>`	Stop a running PDS. pds : `RunningPds` Returns: `Task<unit>`
`url pds` Full Usage: `url pds` Parameters: pds : `RunningPds` Returns: `string`	Get the base URL of a running PDS. pds : `RunningPds` Returns: `string`
`withAccessTokenLifetime lifetime builder` Full Usage: `withAccessTokenLifetime lifetime builder` Parameters: lifetime : `TimeSpan` builder : `PdsBuilder` Returns: `PdsBuilder`	Set the access token lifetime (default: 2 hours). lifetime : `TimeSpan` builder : `PdsBuilder` Returns: `PdsBuilder`
`withAdminPassword password builder` Full Usage: `withAdminPassword password builder` Parameters: password : `string` builder : `PdsBuilder` Returns: `PdsBuilder`	Set the admin password. password : `string` builder : `PdsBuilder` Returns: `PdsBuilder`
`withInviteCode code builder` Full Usage: `withInviteCode code builder` Parameters: code : `string` builder : `PdsBuilder` Returns: `PdsBuilder`	Require invite codes for account creation. code : `string` builder : `PdsBuilder` Returns: `PdsBuilder`
`withPort port builder` Full Usage: `withPort port builder` Parameters: port : `int` builder : `PdsBuilder` Returns: `PdsBuilder`	Set the port the PDS listens on (default: 2583). port : `int` builder : `PdsBuilder` Returns: `PdsBuilder`
`withRefreshTokenLifetime lifetime builder` Full Usage: `withRefreshTokenLifetime lifetime builder` Parameters: lifetime : `TimeSpan` builder : `PdsBuilder` Returns: `PdsBuilder`	Set the refresh token lifetime (default: 90 days). lifetime : `TimeSpan` builder : `PdsBuilder` Returns: `PdsBuilder`
`withSigningKey key builder` Full Usage: `withSigningKey key builder` Parameters: key : `KeyPair` builder : `PdsBuilder` Returns: `PdsBuilder`	Set a pre-generated signing key. key : `KeyPair` builder : `PdsBuilder` Returns: `PdsBuilder`