Table of Contents

Class Properties

Namespace
idunno.Bluesky.Embed.External
Assembly
idunno.Bluesky.dll

The properties for an embedded external media record.

[JsonPolymorphic(IgnoreUnrecognizedTypeDiscriminators = true, UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]
[JsonDerivedType(typeof(Properties), "app.bsky.embed.external#external")]
public record Properties : IEquatable<Properties>

Inheritance

Implements

Inherited Members

Constructors

Properties(string, string, string, Blob?, IReadOnlyCollection<StrongReference>?)

Creates a new instance of idunno.Bluesky.Embed.External.Properties.

[JsonConstructor]
public Properties(string uri, string title, string description, Blob? thumbnail = null, IReadOnlyCollection<StrongReference>? associatedRefs = null)

Parameters

uri string

The external uri, as a string, for the link.

title string

The title for the external link.

description string

The description of the external link, if any.

thumbnail Blob?

The idunno.AtProto.Blob for the thumbnail of the link, if any.

associatedRefs IReadOnlyCollection<StrongReference>?

The collection of idunno.AtProto.Repo.StrongReference representing the Atmosphere records for this external content, if any.

Exceptions

ArgumentException

Thrown when uri is null or whitespace.

ArgumentNullException

Thrown when title or description is null.

Properties(Properties) 

protected Properties(Properties original)

Parameters

original Properties

Properties(string, string, string, Blob?, IReadOnlyCollection<StrongReference>?)

Creates a new instance of idunno.Bluesky.Embed.External.Properties.

[JsonConstructor]
public Properties(string uri, string title, string description, Blob? thumbnail = null, IReadOnlyCollection<StrongReference>? associatedRefs = null)

Parameters

uri string

The external uri, as a string, for the link.

title string

The title for the external link.

description string

The description of the external link, if any.

thumbnail Blob?

The idunno.AtProto.Blob for the thumbnail of the link, if any.

associatedRefs IReadOnlyCollection<StrongReference>?

The collection of idunno.AtProto.Repo.StrongReference representing the Atmosphere records for this external content, if any.

Exceptions

ArgumentException

Thrown when uri is null or whitespace.

ArgumentNullException

Thrown when title or description is null.

Properties(Properties) 

protected Properties(Properties original)

Parameters

original Properties

Properties(string, string, string, Blob?, IReadOnlyCollection<StrongReference>?)

Creates a new instance of idunno.Bluesky.Embed.External.Properties.

[JsonConstructor]
public Properties(string uri, string title, string description, Blob? thumbnail = null, IReadOnlyCollection<StrongReference>? associatedRefs = null)

Parameters

uri string

The external uri, as a string, for the link.

title string

The title for the external link.

description string

The description of the external link, if any.

thumbnail Blob?

The idunno.AtProto.Blob for the thumbnail of the link, if any.

associatedRefs IReadOnlyCollection<StrongReference>?

The collection of idunno.AtProto.Repo.StrongReference representing the Atmosphere records for this external content, if any.

Exceptions

ArgumentException

Thrown when uri is null or whitespace.

ArgumentNullException

Thrown when title or description is null.

Properties(Properties) 

protected Properties(Properties original)

Parameters

original Properties

Properties

AssociatedRefs

Gets or sets a collection of idunno.AtProto.Repo.StrongReferences to the Atmosphere records representing this external content, if they exist.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyCollection<StrongReference>? AssociatedRefs { get; set; }

Property Value

IReadOnlyCollection<StrongReference>?

AssociatedRefs

Gets or sets a collection of idunno.AtProto.Repo.StrongReferences to the Atmosphere records representing this external content, if they exist.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyCollection<StrongReference>? AssociatedRefs { get; set; }

Property Value

IReadOnlyCollection<StrongReference>?

AssociatedRefs

Gets or sets a collection of idunno.AtProto.Repo.StrongReferences to the Atmosphere records representing this external content, if they exist.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyCollection<StrongReference>? AssociatedRefs { get; set; }

Property Value

IReadOnlyCollection<StrongReference>?

Description

Gets or sets the description of the external link.

[JsonInclude]
[JsonRequired]
public string Description { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

Description

Gets or sets the description of the external link.

[JsonInclude]
[JsonRequired]
public string Description { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

Description

Gets or sets the description of the external link.

[JsonInclude]
[JsonRequired]
public string Description { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

EqualityContract 

protected virtual Type EqualityContract { get; }

Property Value

Type

EqualityContract 

protected virtual Type EqualityContract { get; }

Property Value

Type

EqualityContract 

protected virtual Type EqualityContract { get; }

Property Value

Type

Thumbnail

Gets or sets the idunno.AtProto.Blob to a thumbnail image for the external link.

[JsonInclude]
[JsonPropertyName("thumb")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Blob? Thumbnail { get; set; }

Property Value

Blob?

Thumbnail

Gets or sets the idunno.AtProto.Blob to a thumbnail image for the external link.

[JsonInclude]
[JsonPropertyName("thumb")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Blob? Thumbnail { get; set; }

Property Value

Blob?

Thumbnail

Gets or sets the idunno.AtProto.Blob to a thumbnail image for the external link.

[JsonInclude]
[JsonPropertyName("thumb")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Blob? Thumbnail { get; set; }

Property Value

Blob?

Title

Gets or sets the title for the external link.

[JsonInclude]
[JsonRequired]
public string Title { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

Title

Gets or sets the title for the external link.

[JsonInclude]
[JsonRequired]
public string Title { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

Title

Gets or sets the title for the external link.

[JsonInclude]
[JsonRequired]
public string Title { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when the value is null.

Uri

Gets or sets the external uri, as a string.

[JsonInclude]
[JsonRequired]
public string Uri { get; set; }

Property Value

string

Remarks

This property is a string to accommodate illegal URIs that the Bluesky web app can create. Validate the URI before using it.

Exceptions

ArgumentException

Thrown when the value is null or whitespace.

Uri

Gets or sets the external uri, as a string.

[JsonInclude]
[JsonRequired]
public string Uri { get; set; }

Property Value

string

Remarks

This property is a string to accommodate illegal URIs that the Bluesky web app can create. Validate the URI before using it.

Exceptions

ArgumentException

Thrown when the value is null or whitespace.

Uri

Gets or sets the external uri, as a string.

[JsonInclude]
[JsonRequired]
public string Uri { get; set; }

Property Value

string

Remarks

This property is a string to accommodate illegal URIs that the Bluesky web app can create. Validate the URI before using it.

Exceptions

ArgumentException

Thrown when the value is null or whitespace.

Methods

<Clone>$() 

public virtual Properties <Clone>$()

Returns

Properties

<Clone>$() 

public virtual Properties <Clone>$()

Returns

Properties

<Clone>$() 

public virtual Properties <Clone>$()

Returns

Properties

Equals(Properties?)

Determines whether the specified idunno.Bluesky.Embed.External.Properties is equal to the current instance.

public virtual bool Equals(Properties? other)

Parameters

other Properties?

The idunno.Bluesky.Embed.External.Properties to compare against the current instance.

Returns

bool

true if other is equal to the current instance, otherwise false.

Remarks

idunno.Bluesky.Embed.External.Properties.AssociatedRefs is compared by its contents rather than by reference.

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(Properties?)

Determines whether the specified idunno.Bluesky.Embed.External.Properties is equal to the current instance.

public virtual bool Equals(Properties? other)

Parameters

other Properties?

The idunno.Bluesky.Embed.External.Properties to compare against the current instance.

Returns

bool

true if other is equal to the current instance, otherwise false.

Remarks

idunno.Bluesky.Embed.External.Properties.AssociatedRefs is compared by its contents rather than by reference.

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(Properties?)

Determines whether the specified idunno.Bluesky.Embed.External.Properties is equal to the current instance.

public virtual bool Equals(Properties? other)

Parameters

other Properties?

The idunno.Bluesky.Embed.External.Properties to compare against the current instance.

Returns

bool

true if other is equal to the current instance, otherwise false.

Remarks

idunno.Bluesky.Embed.External.Properties.AssociatedRefs is compared by its contents rather than by reference.

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

GetHashCode()

Returns the hash code for the current instance.

public override int GetHashCode()

Returns

int

The hash code for the current instance.

Remarks

The hash code is derived from the current property values, so it changes if the instance is mutated. Do not mutate an instance while it is being used as a key in a hashed collection.

GetHashCode()

Returns the hash code for the current instance.

public override int GetHashCode()

Returns

int

The hash code for the current instance.

Remarks

The hash code is derived from the current property values, so it changes if the instance is mutated. Do not mutate an instance while it is being used as a key in a hashed collection.

GetHashCode()

Returns the hash code for the current instance.

public override int GetHashCode()

Returns

int

The hash code for the current instance.

Remarks

The hash code is derived from the current property values, so it changes if the instance is mutated. Do not mutate an instance while it is being used as a key in a hashed collection.

PrintMembers(StringBuilder) 

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

PrintMembers(StringBuilder) 

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

PrintMembers(StringBuilder) 

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString() 

public override string ToString()

Returns

string

ToString() 

public override string ToString()

Returns

string

ToString() 

public override string ToString()

Returns

string

Operators

operator ==(Properties?, Properties?) 

public static bool operator ==(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool

operator ==(Properties?, Properties?) 

public static bool operator ==(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool

operator ==(Properties?, Properties?) 

public static bool operator ==(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool

operator !=(Properties?, Properties?) 

public static bool operator !=(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool

operator !=(Properties?, Properties?) 

public static bool operator !=(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool

operator !=(Properties?, Properties?) 

public static bool operator !=(Properties? left, Properties? right)

Parameters

left Properties?
right Properties?

Returns

bool