Table of Contents

Interface IActionContext

Namespace
Phoesion.Glow.SDK.Firefly
Assembly
Phoesion.Glow.SDK.Firefly.Abstractions.dll
public interface IActionContext
Extension Methods

Properties

ActionMethod

MethodInfo ActionMethod { get; }

Property Value

MethodInfo

ActionName

string ActionName { get; set; }

Property Value

string

CancellationToken

Cancellation token for this request

CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

ClientId

string? ClientId { get; }

Property Value

string

Configuration

IConfiguration Configuration { get; }

Property Value

IConfiguration

ConnectionInfo

IClientConnectionInfo ConnectionInfo { get; }

Property Value

IClientConnectionInfo

ConnectionType

ClientConnectionTypes ConnectionType { get; }

Property Value

ClientConnectionTypes

EndpointAttributes

IReadOnlyList<Attribute> EndpointAttributes { get; }

Property Value

IReadOnlyList<Attribute>

Features

IFeatureCollection Features { get; }

Property Value

IFeatureCollection

InteropRequest

IPhotonInteropRequest InteropRequest { get; set; }

Property Value

IPhotonInteropRequest

InteropResponse

IPhotonInteropResponse InteropResponse { get; set; }

Property Value

IPhotonInteropResponse

IsCancellationRequested

Gets whether cancellation has been requested for this token.

bool IsCancellationRequested { get; }

Property Value

bool

Items

IDictionary<object, object?> Items { get; set; }

Property Value

IDictionary<object, object>

Logger

ILogger Logger { get; }

Property Value

ILogger

Module

IFireflyModule Module { get; set; }

Property Value

IFireflyModule

Operation

StickyOperation Operation { get; }

Property Value

StickyOperation

OperationId

string? OperationId { get; }

Property Value

string

PhotonId

PhotonId PhotonId { get; }

Property Value

PhotonId

PhotonRequest

IPhotonRequest PhotonRequest { get; set; }

Property Value

IPhotonRequest

PhotonResponse

IPhotonResponse PhotonResponse { get; set; }

Property Value

IPhotonResponse

PushClientId

string? PushClientId { get; }

Property Value

string

RayId

RayId RayId { get; }

Property Value

RayId

Request

IPhotonActionRequest Request { get; set; }

Property Value

IPhotonActionRequest

Response

IPhotonActionResponse Response { get; set; }

Property Value

IPhotonActionResponse

Services

IServiceProvider Services { get; set; }

Property Value

IServiceProvider

User

ClaimsPrincipal User { get; set; }

Property Value

ClaimsPrincipal

Methods

AddTraceEvent(string)

Add tracing event

void AddTraceEvent(string name)

Parameters

name string

AddTraceEvent(string, LogLevel)

Add tracing event

void AddTraceEvent(string name, LogLevel type)

Parameters

name string
type LogLevel

AddTraceEvent(string, LogLevel, Dictionary<string, object?>?)

Add tracing event

void AddTraceEvent(string name, LogLevel type, Dictionary<string, object?>? tags)

Parameters

name string
type LogLevel
tags Dictionary<string, object>

AddTraceEvent(string, LogLevel, Dictionary<string, object?>?, DateTimeOffset)

Add tracing event

void AddTraceEvent(string name, LogLevel type, Dictionary<string, object?>? tags, DateTimeOffset timestamp)

Parameters

name string
type LogLevel
tags Dictionary<string, object>
timestamp DateTimeOffset

AddTraceEvent(string, Dictionary<string, object?>?)

Add tracing event

void AddTraceEvent(string name, Dictionary<string, object?>? tags)

Parameters

name string
tags Dictionary<string, object>

AddTraceEvent(string, Dictionary<string, object?>?, DateTimeOffset)

Add tracing event

void AddTraceEvent(string name, Dictionary<string, object?>? tags, DateTimeOffset timestamp)

Parameters

name string
tags Dictionary<string, object>
timestamp DateTimeOffset

OnResponseCompleted(Func<object, Task>, object?)

void OnResponseCompleted(Func<object, Task> callback, object? state)

Parameters

callback Func<object, Task>
state object

OnResponseStarting(Func<object, Task>, object?)

void OnResponseStarting(Func<object, Task> callback, object? state)

Parameters

callback Func<object, Task>
state object

ReportIncident(IncidentTypes, string, string?, object?, string?, bool, string?, string?)

Task<bool> ReportIncident(IncidentTypes type, string title, string? description, object? data, string? category = null, bool IsEntitySpecific = false, string? callerFilePath = null, string? callerMemberName = null)

Parameters

type IncidentTypes
title string
description string
data object
category string
IsEntitySpecific bool
callerFilePath string
callerMemberName string

Returns

Task<bool>

StartTraceActivity(string)

Start a trace activity

Activity? StartTraceActivity(string name)

Parameters

name string

Returns

Activity

StartTraceActivity(string, ActivityKind)

Activity? StartTraceActivity(string name, ActivityKind kind)

Parameters

name string
kind ActivityKind

Returns

Activity

SubmitProgressUpdate(byte, byte, string)

Informs the caller about a status update. This is a best-effort mechanism that batches and issues updates at specific intervals (typically every few seconds), so not all updates will be invoked on the called in case of frequent updating

void SubmitProgressUpdate(byte progress, byte state, string status)

Parameters

progress byte
state byte
status string

ThrowIfCancellationRequested()

Throws a System.OperationCanceledException if this token has had cancellation requested.

void ThrowIfCancellationRequested()