Interface IAdamService
WIP - Adam Service for additional ADAM operations such as retrieving a single file
Namespace: ToSic.Sxc.Services
Assembly: ToSic.Sxc.dll
Syntax
[InternalApi_DoNotUse_MayChangeWithoutNotice("WIP 14.04")]
public interface IAdamServiceMethods
| Improve this Doc View SourceFile(Int32)
Retrieve a file by int-id (usually the ID managed by the platform)
Declaration
IFile File(int id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | File ID |
Returns
| Type | Description |
|---|---|
| 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"
Declaration
IFile File(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | File ID String |
Returns
| Type | Description |
|---|---|
| IFile | The file object or null if not found or something else went wrong. |
File(IDynamicField)
Retrieve a file referenced in the field
Declaration
IFile File(IDynamicField field)Parameters
| Type | Name | Description |
|---|---|---|
| IDynamicField | field |
Returns
| Type | Description |
|---|---|
| IFile | The file object or null if not found or something else went wrong. |
Folder(Int32)
Provides an Adam Folder for the ID
Declaration
IFolder Folder(int id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | Folder ID |
Returns
| Type | Description |
|---|---|
| IFolder | An Adam object for navigating the assets |
Folder(IDynamicField)
Provides an Adam Folder for this item and field
Declaration
IFolder Folder(IDynamicField field)Parameters
| Type | Name | Description |
|---|---|---|
| IDynamicField | field | The Field information object for which to get the folder |
Returns
| Type | Description |
|---|---|
| IFolder | An Adam object for navigating the assets |