Documentation

Object model

Core page objects

There are almost thirty different page objects that can be returned from content calls in ThoughtFarmer. Of those, the three main objects returned are Page, Document and Profile. These objects all inherit from the class IPage.

IPage
Properties
Node: Node
Security: ISecurity
Audit: Audit
SortOrder: int
IsInNavigation: bool
Title: LocalizedSortedList
AbbrevTitle: LocalizedSortedList
Summary: LocalizedSortedList
Url: string

Methods
EditUrl(string culture): string

Page
Properties
AllowFiles: bool
AllowComments: bool
Tags: Tags
Feed: FeedOptions
NewsFeed: FeedOptions
Content: Content
Layout: Layout
AvailableLayouts: IEnumerable<Layout>
AvailablePageTypeConversions: IEnumerable<PageType>

Document
The Document object represents a file attachment

Properties
AllowComments: bool
Tags: Tags
Feed: FeedOptions
CurrentFile: File
RenderUrl: string
CommentCount: int
FileVersions: List<File>
PreviousVersions: List<File>
FileLock: FileLock
FileIsLocked: bool
Content: Content
Summary: LocalizedSortedList

Profile
The profile object represents a user's profile page

Properties
AllowFiles: bool
AllowComments: bool
Tags: Tags
Feed: FeedOptions
Summary: string
User: User
Content: Content

Methods
EditUrl(string culture): string

Supporting objects

These objects are the parts that the above page objects are composed of. They represent additional properties that each object can have.

Content
Properties
DefaultPhoto: Image
Photos: List<Image>
Body: LocalizedSortedList
HasPhotos: bool

Tags
Properties
List: IList<Tag>

Methods
Contains(string tag): bool

Tag
Properties
TagId: int
Name: string

Node
Properties
ContentId: int
ParentId: int
TreePath: string
Deleted: bool

Audit
Properties
InheritedIsPublished: bool
IsPublished: bool
InheritedIsArchived: bool
IsArchived: bool
PublishedDate: DateTime
ModifiedDate: DateTime
CreatedDate: DateTime
VersionModifiedDate: DateTime
ModifiedById: int
CreatorId: int
OwnerId: int
VersionModifiedById: int
LastUpdatedByUserId: int
PublishedStatus: PublishedStatus
InheritedArchivedContentId: int

ISecurity
Properties
InheritsPageSecurity: bool
InheritsPermissionsContentId: int
InheritsPermissionsContentOwnerId: int

User
Properties
ContentId: int
UserId: int
HideArchivedContent: bool
AllowAdminMode: bool
AreFavoritesPublic: bool
Birthday: DateTime
BirthdayDisplay: BirthdayDisplay
BirthdayFormat: string
DefaultCulture: string
Deleted: bool
DisplayName: string
DomainLogin: string
Email: string
FirstName: string
FullNameAndJobTitle: string
FullName: string
FullNameLastNameFirst: string
GroupTitle: string
Hidden: bool
IsAdministrator: bool
IsCustomAddress: bool
IsEndUserAgreementAccepted: bool
IsGuest: bool
JobTitle: string
LastName: string
LeaderPrimaryId: int
LeaderSecondaryId: int
NotifyOnPageOwnedModified: bool
NotifyOnPageEditedModified: bool
NotifyOnFavoriteModified: bool
PhoneTel: string
PhoneMobile: string
PhoneFax: string
Image: Image
SalutationId: int
Status: string
StatusLastUpdated: DateTime
TimeZone: TimeZoneInfo
Url: string
UserAddressLine1: string
UserAddressLine2: string
UserAddressLine3: string
UserAddressLine4: string
UserGroupContentId: int
UserState: UserState

Methods
CanEdit(IPage content): bool
CanEdit(IPage content, bool checkOwnerLock): bool
CanView(IPage content): bool

File
Properties
VersionNumber: int?
FileVersionId: int
ContentId: int
MimeType: string
FileSize: int
IsCurrent: bool
DateModified: DateTime
DateTaken: DateTime
CreatorId: int
Dimensions: Size
DataLoaded: bool
Creator: IUser
Data: byte[]
ExtractedText: string
FileName: string
Extension: string
DownloadUrl: string
DownloadVersionUrl: string

Methods
GetDisplayUrl(int width, int height, bool cropped): string
GetGalleryUrl(int width, int height): string

Image
Properties
ImageId: int
CurrentPage: IPage
CurrentUserId: int
PosterId: int
ModifiedId: int
ContentId: int
SortOrder: int
FileName: string
ContentType: string
DatePosted: DateTime
DateModified: DateTime
Deleted: bool
Dimensions: Size
IsPostThumbnail: bool
SubType: ImageSubType
Data: byte[]

Methods
GetUrl(int width, int height, bool cropped): string