View Source
Interface IPublicAccessService
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
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
Returns
View Source
Delete(PublicAccessEntry)
Deletes the entry and all associated rules
Declaration
Attempt<OperationResult> Delete(PublicAccessEntry entry)
Parameters
Returns
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
View Source
GetAll()
Gets all defined entries and associated rules
Declaration
IEnumerable<PublicAccessEntry> GetAll()
Returns
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
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
View Source
GetEntryForContent(IContent)
Gets the entry defined for the content item's path
Declaration
PublicAccessEntry GetEntryForContent(IContent content)
Parameters
Returns
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
View Source
IsProtected(IContent)
Returns true if the content has an entry for it's path
Declaration
Attempt<PublicAccessEntry> IsProtected(IContent content)
Parameters
Returns
View Source
RemoveRule(IContent, String, String)
Declaration
Attempt<OperationResult> RemoveRule(IContent content, string ruleType, string ruleValue)
Parameters
| Type |
Name |
Description |
| IContent |
content |
|
| System.String |
ruleType |
|
| System.String |
ruleValue |
|
Returns
View Source
Save(PublicAccessEntry)
Declaration
Attempt<OperationResult> Save(PublicAccessEntry entry)
Parameters
Returns
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
Returns