Interface IPublicAccessService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IPublicAccessService : IService

Methods

View Source

AddRule(IContent, String, String)

Adds a rule if the entry doesn't already exist

Declaration

Attempt<OperationResult<OperationResultType, PublicAccessEntry>> AddRule(IContent content, string ruleType, string ruleValue)

Parameters

Type	Name	Description
IContent	content
System.String	ruleType
System.String	ruleValue

Returns

Type	Description
Attempt<OperationResult<OperationResultType, PublicAccessEntry>>

View Source

CreateAsync(PublicAccessEntrySlim)

Saves the entry asynchronously and returns a status result whether the operation succeeded or not

Declaration

Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>> CreateAsync(PublicAccessEntrySlim entry)

Parameters

Type	Name	Description
PublicAccessEntrySlim	entry

Returns

Type	Description
Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>>

View Source

Delete(PublicAccessEntry)

Deletes the entry and all associated rules

Declaration

Attempt<OperationResult> Delete(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationResult>

View Source

DeleteAsync(Guid)

Deletes the entry and all associated rules for a given key.

Declaration

Task<Attempt<PublicAccessOperationStatus>> DeleteAsync(Guid key)

Parameters

Type	Name	Description
Guid	key

Returns

Type	Description
Task<Attempt<PublicAccessOperationStatus>>

View Source

GetAll()

Gets all defined entries and associated rules

Declaration

IEnumerable<PublicAccessEntry> GetAll()

Returns

Type	Description
IEnumerable<PublicAccessEntry>

View Source

GetEntryByContentKeyAsync(Guid)

Gets the entry defined for the content item based on a content key

Declaration

Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>> GetEntryByContentKeyAsync(Guid key)

Parameters

Type	Name	Description
Guid	key

Returns

Type	Description
Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>>	Returns null if no entry is found

Remarks

This method supports inheritance by considering ancestor entries (if any), if no entry is found for the specified content key.

View Source

GetEntryByContentKeyWithoutAncestorsAsync(Guid)

Gets the entry defined for the content item based on a content key, without taking ancestor entries into account.

Declaration

virtual Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>> GetEntryByContentKeyWithoutAncestorsAsync(Guid key)

Parameters

Type	Name	Description
Guid	key

Returns

Type	Description
Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>>	Returns null if no entry is found

Remarks

This method does not support inheritance. Use GetEntryByContentKeyAsync(Guid) to include ancestor entries (if any).

View Source

GetEntryForContent(String)

Gets the entry defined for the content item based on a content path

Declaration

PublicAccessEntry GetEntryForContent(string contentPath)

Parameters

Type	Name	Description
System.String	contentPath

Returns

Type	Description
PublicAccessEntry	Returns null if no entry is found

View Source

GetEntryForContent(IContent)

Gets the entry defined for the content item's path

Declaration

PublicAccessEntry GetEntryForContent(IContent content)

Parameters

Type	Name	Description
IContent	content

Returns

Type	Description
PublicAccessEntry	Returns null if no entry is found

View Source

IsProtected(String)

Returns true if the content has an entry based on a content path

Declaration

Attempt<PublicAccessEntry> IsProtected(string contentPath)

Parameters

Type	Name	Description
System.String	contentPath

Returns

Type	Description
Attempt<PublicAccessEntry>

View Source

IsProtected(IContent)

Returns true if the content has an entry for it's path

Declaration

Attempt<PublicAccessEntry> IsProtected(IContent content)

Parameters

Type	Name	Description
IContent	content

Returns

Type	Description
Attempt<PublicAccessEntry>

View Source

RemoveRule(IContent, String, String)

Removes a rule

Declaration

Attempt<OperationResult> RemoveRule(IContent content, string ruleType, string ruleValue)

Parameters

Type	Name	Description
IContent	content
System.String	ruleType
System.String	ruleValue

Returns

Type	Description
Attempt<OperationResult>

View Source

Save(PublicAccessEntry)

Saves the entry

Declaration

Attempt<OperationResult> Save(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationResult>

View Source

UpdateAsync(PublicAccessEntrySlim)

Updates the entry asynchronously and returns a status result whether the operation succeeded or not

Declaration

Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>> UpdateAsync(PublicAccessEntrySlim entry)

Parameters

Type	Name	Description
PublicAccessEntrySlim	entry

Returns

Type	Description
Task<Attempt<PublicAccessEntry, PublicAccessOperationStatus>>