Class PublicAccessService

Inheritance

System.Object

RepositoryService

ScopeRepositoryService

Namespace:System.Dynamic.ExpandoObject

Assembly:Umbraco.Core.dll

Syntax

public class PublicAccessService : ScopeRepositoryService, IPublicAccessService, IService

Constructors

PublicAccessService(IDatabaseUnitOfWorkProvider, RepositoryFactory, ILogger, IEventMessagesFactory)

Declaration

public PublicAccessService(IDatabaseUnitOfWorkProvider provider, RepositoryFactory repositoryFactory, ILogger logger, IEventMessagesFactory eventMessagesFactory)

Parameters

Type	Name	Description
IDatabaseUnitOfWorkProvider	provider
RepositoryFactory	repositoryFactory
ILogger	logger
IEventMessagesFactory	eventMessagesFactory

Methods

AddOrUpdateRule(IContent, String, String)

Declaration

[Obsolete("Use AddRule instead, this method will be removed in future versions")]
public Attempt<OperationStatus<PublicAccessEntry, OperationStatusType>> AddOrUpdateRule(IContent content, string ruleType, string ruleValue)

Parameters

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

Returns

Type	Description
Attempt<OperationStatus<PublicAccessEntry, OperationStatusType>>

AddRule(IContent, String, String)

Adds a rule

Declaration

public Attempt<OperationStatus<PublicAccessEntry, OperationStatusType>> AddRule(IContent content, string ruleType, string ruleValue)

Parameters

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

Returns

Type	Description
Attempt<OperationStatus<PublicAccessEntry, OperationStatusType>>

Delete(PublicAccessEntry)

Deletes the entry and all associated rules

Declaration

public Attempt<OperationStatus> Delete(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationStatus>

GetAll()

Gets all defined entries and associated rules

Declaration

public IEnumerable<PublicAccessEntry> GetAll()

Returns

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

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

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

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>

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>

RemoveRule(IContent, String, String)

Removes a rule

Declaration

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

Parameters

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

Returns

Type	Description
Attempt<OperationStatus>

Save(PublicAccessEntry)

Saves the entry

Declaration

public Attempt<OperationStatus> Save(PublicAccessEntry entry)

Parameters

Type	Name	Description
PublicAccessEntry	entry

Returns

Type	Description
Attempt<OperationStatus>

Events

Deleted

Occurs after Delete

Declaration

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

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>>

Deleting

Occurs before Delete

Declaration

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

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, DeleteEventArgs<PublicAccessEntry>>

Saved

Occurs after Save

Declaration

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

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>>

Saving

Occurs before Save

Declaration

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

Event Type

Type	Description
TypedEventHandler<IPublicAccessService, SaveEventArgs<PublicAccessEntry>>