Class Person
This is the full Person object that can be retrieved with all of it's data.
Implements
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public sealed class Person : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IItemByName, IHasFolderGrouping, IHasLookupInfo<PersonLookupInfo>Properties
ContainingFolderPath
Returns the folder containing the item. If the item is a folder, it returns the folder itself
Declaration
[IgnoreDataMember]
public override string ContainingFolderPath { get; }Property Value
| Type | Description |
|---|---|
| System.String | The containing folder path. |
Overrides
EnableAlphaNumericSorting
Declaration
[IgnoreDataMember]
public override bool EnableAlphaNumericSorting { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
ForceDefaultAspectRatio
Declaration
[IgnoreDataMember]
public override bool ForceDefaultAspectRatio { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsAncestors
Declaration
[IgnoreDataMember]
public override bool SupportsAncestors { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsPeople
Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Methods
AllowEditingField(MetadataFields)
Declaration
public override bool AllowEditingField(MetadataFields field)Parameters
| Type | Name | Description |
|---|---|---|
| MetadataFields | field |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
CanDelete()
Declaration
public override bool CanDelete()Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
GetDefaultPrimaryImageAspectRatio()
Declaration
public override double GetDefaultPrimaryImageAspectRatio()Returns
| Type | Description |
|---|---|
| System.Double |
Overrides
GetInternalMetadataPath(String)
Declaration
protected override string GetInternalMetadataPath(string basePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | basePath |
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
GetItemIdList(InternalItemsQuery, IDataContext, CancellationToken)
Declaration
public long[] GetItemIdList(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| InternalItemsQuery | query | |
| IDataContext | dataContext | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Int64[] |
GetItemIdList(InternalItemsQuery, CancellationToken)
Declaration
public long[] GetItemIdList(InternalItemsQuery query, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| InternalItemsQuery | query | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Int64[] |
GetItems(InternalItemsQuery, CancellationToken)
Declaration
public QueryResult<BaseItem> GetItems(InternalItemsQuery query, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| InternalItemsQuery | query | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| QueryResult<BaseItem> |
GetLookupInfo(LibraryOptions)
Declaration
public PersonLookupInfo GetLookupInfo(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| PersonLookupInfo |
GetMediaContainingFolderPath(LibraryOptions, CancellationToken)
Declaration
public override string GetMediaContainingFolderPath(LibraryOptions libraryOptions, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
GetUserDataKeyInternal(IDataContext)
Declaration
protected override string GetUserDataKeyInternal(IDataContext dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| IDataContext | dataContext |
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
IsLocalMetadataReaderEnabled(LibraryOptions, String)
Declaration
public override bool IsLocalMetadataReaderEnabled(LibraryOptions libraryOptions, string name)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions | |
| System.String | name |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
IsSaveLocalImagesEnabled(LibraryOptions)
Declaration
public override bool IsSaveLocalImagesEnabled(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SetAutoSorting(InternalItemsQuery, List<(String, SortOrder)>)
Declaration
protected override void SetAutoSorting(InternalItemsQuery query, List<(string, SortOrder)> orderBy)Parameters
| Type | Name | Description |
|---|---|---|
| InternalItemsQuery | query | |
| System.Collections.Generic.List<System.ValueTuple<System.String, SortOrder>> | orderBy |