Interface IAdamService

Namespace

ToSic.Sxc.Services

Assembly

ToSic.Sxc.Adam.dll

Internal: Adam Service for ADAM operations such as retrieving a single file.

[InternalApi_DoNotUse_MayChangeWithoutNotice("WIP 14.04")]
public interface IAdamService

Remarks

Avoid using this, as most objects will already have their ADAM properties such as File or Folder.

History: Introduced as WIP in v14.04.

Methods

File(int)

Retrieve a file by int-id (usually the ID managed by the platform)

IFile? File(int id)

Parameters

id int

File ID

Returns

IFile

The file object or null if not found or something else went wrong.

File(string)

Retrieve a file using the string-key such as "file:72"

IFile? File(string id)

Parameters

id string

File ID String

Returns

IFile

The file object or null if not found or something else went wrong.

File(IField)

Retrieve a file referenced in the field

IFile? File(IField field)

Parameters

field IField

Returns

IFile

The file object or null if not found or something else went wrong.

Folder(int)

Provides an Adam Folder for the ID

IFolder? Folder(int id)

Parameters

id int

Folder ID

Returns

IFolder

An Adam object for navigating the assets

Folder(IField)

Provides an Adam Folder for this item and field

IFolder? Folder(IField field)

Parameters

field IField

The Field information object for which to get the folder

Returns

IFolder

An Adam object for navigating the assets