ApplicationActionState Class Reference

#include <application_action_state.h>

Public Member Functions
virtual LabelState	GetNewLabelState () const =0
	Gets the new label state.
virtual std::shared_ptr< Label >	GetNewLabel () const =0
	Gets the sensitivity label ID that should be applied on the document.
virtual std::pair< bool, std::string >	IsDowngradeJustified () const =0
	Implementation should pass if justification to downgrade an existing label was given.
virtual AssignmentMethod	GetNewLabelAssignmentMethod () const =0
	Get the new label's assignment method.
virtual std::vector< std::pair< std::string, std::string > >	GetNewLabelExtendedProperties () const
	Return new label's extended properties.
virtual ActionType	GetSupportedActions () const =0
	Gets a masked enum describing all the supported action types.
virtual bool	IsRecommendationEnabled () const =0
	Get a bool that signifying recommend action will return. by default should be true unless user specifies else.
virtual int	GetContentTimeZoneUtcOffset () const
	Return the content's time zone as an offset from UTC, in seconds, or kTimeZoneOffsetLocalTime to use the machine's local time.

Member Function Documentation

GetContentTimeZoneUtcOffset()

virtual int ApplicationActionState::GetContentTimeZoneUtcOffset ( ) const

inlinevirtual

Return the content's time zone as an offset from UTC, in seconds, or kTimeZoneOffsetLocalTime to use the machine's local time.

Returns

The content's time zone as an offset from UTC, in seconds, or kTimeZoneOffsetLocalTime to use the machine's local time.

GetNewLabel()

virtual std::shared_ptr< Label > ApplicationActionState::GetNewLabel ( ) const

pure virtual

Gets the sensitivity label ID that should be applied on the document.

Returns

sensitivity label ID to be applied to the content if exists else empty to remove label.

GetNewLabelAssignmentMethod()

virtual AssignmentMethod ApplicationActionState::GetNewLabelAssignmentMethod ( ) const

pure virtual

Get the new label's assignment method.

Returns

the assignment method STANDARD, PRIVILEGED, AUTO.

See also

mip::AssignmentMethod

GetNewLabelExtendedProperties()

virtual std::vector< std::pair< std::string, std::string > > ApplicationActionState::GetNewLabelExtendedProperties ( ) const

inlinevirtual

Return new label's extended properties.

Returns

the extended properties applied to the content.

GetNewLabelState()

virtual LabelState ApplicationActionState::GetNewLabelState ( ) const

pure virtual

Gets the new label state.

Returns

the new label state.

See also

mip::LabelState

GetSupportedActions()

virtual ActionType ApplicationActionState::GetSupportedActions ( ) const

pure virtual

Gets a masked enum describing all the supported action types.

Returns

a masked enum describing all the supported action types.

Note

ActionType::Justify must be supported. When a policy and label change requires justification, a justification action will always be returned.

IsDowngradeJustified()

virtual std::pair< bool, std::string > ApplicationActionState::IsDowngradeJustified ( ) const

pure virtual

Implementation should pass if justification to downgrade an existing label was given.

Returns

true if downgrade is justified–along with the justification message–else false

See also

mip::JustifyAction

IsRecommendationEnabled()

virtual bool ApplicationActionState::IsRecommendationEnabled ( ) const

pure virtual

Get a bool that signifying recommend action will return. by default should be true unless user specifies else.

Returns

a bool that signifying recommend action will return.

Note

ActionType::RecommendLabel must be enable for this field to have an affect.

---

The documentation for this class was generated from the following file:

• /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/upe/core/application_action_state.h