Class PublicAccessService

Inheritance

System.Object

Namespace: Umbraco.Core.Services.Implement

Assembly: Umbraco.Core.dll

Syntax

public class PublicAccessService : ScopeRepositoryService, IPublicAccessService, IService

Constructors

View Source

PublicAccessService(IScopeProvider, ILogger, IEventMessagesFactory, IPublicAccessRepository)

Declaration

public PublicAccessService(IScopeProvider provider, ILogger logger, IEventMessagesFactory eventMessagesFactory, IPublicAccessRepository publicAccessRepository)

Parameters

Type	Name	Description
IScopeProvider	provider
ILogger	logger
IEventMessagesFactory	eventMessagesFactory
IPublicAccessRepository	publicAccessRepository

Methods

View Source

AddRule(IContent, String, String)

Adds a rule

Declaration

public 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

Delete(PublicAccessEntry)

Deletes the entry and all associated rules

Declaration

public Attempt<OperationResult> Delete(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationResult>

View Source

GetAll()

Gets all defined entries and associated rules

Declaration

public IEnumerable<PublicAccessEntry> GetAll()

Returns

Type	Description
System.Collections.Generic.IEnumerable<PublicAccessEntry>

View Source

GetEntryForContent(String)

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

Declaration

public PublicAccessEntry GetEntryForContent(string contentPath)

Parameters

Type	Name	Description
System.String	contentPath

Returns

Type	Description
PublicAccessEntry	Returns null if no entry is found

Remarks

NOTE: This method get's called very often! This will return the results from cache

View Source

GetEntryForContent(IContent)

Gets the entry defined for the content item's path

Declaration

public 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

public 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

public 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

public 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

public Attempt<OperationResult> Save(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationResult>

Events

View Source

Deleted

Occurs after Delete

Declaration

public static event TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>> Deleted

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>>

View Source

Deleting

Occurs before Delete

Declaration

public static event TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>> Deleting

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>>

View Source

Saved

Occurs after Save

Declaration

public static event TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>> Saved

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>>

View Source

Saving

Occurs before Save

Declaration

public static event TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>> Saving

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>>