Label Class Reference

Abstraction for a single Microsoft Information Protection label. More...

#include <label.h>

Public Member Functions
virtual const std::string &	GetId () const =0
	Get the label ID.
virtual const std::string &	GetName () const =0
	Get the label name.
virtual const std::string &	GetDescription () const =0
	Get the label description.
virtual const std::string &	GetColor () const =0
	Get the color the label should be displayed.
virtual int	GetSensitivity () const =0
	Get the Sensitivity of the label.
virtual const std::string &	GetTooltip () const =0
	Get the tooltip description of the label.
virtual const std::string &	GetAutoTooltip () const =0
	Get the tooltip description of the classification that cause this label to be applied.
virtual bool	IsActive () const =0
	Gets a boolean signaling if the label is active.
virtual std::weak_ptr< Label >	GetParent () const =0
	Get the parent label.
virtual const std::vector< std::shared_ptr< Label > > &	GetChildren () const =0
	Get the children labels of the current label.
virtual const std::vector< std::pair< std::string, std::string > > &	GetCustomSettings () const =0
	Get the custom settings of a label.
virtual ActionSource	GetActionSource () const =0
	Gets the action source of the label.
virtual const std::vector< std::string > &	GetContentFormats () const =0
	Gets content types.
virtual std::string	GetDoubleKeyUrl () const =0
	Gets the double key URL, if the label requires double key user defined protection.
virtual bool	HasRightsManagementPolicy () const =0
	Gets whether the label is associated with a policy that applies protection.
virtual bool	HasDoNotForwardProtection () const =0
	Gets whether the label is associated with a policy that applies do not forward protection.
virtual bool	HasEncryptOnlyProtection () const =0
	Gets whether the label is associated with a policy that applies encrypt only protection.
virtual bool	HasAdhocProtection () const =0
	Gets whether the label is associated with a policy that applies adhoc protection.

Detailed Description

Abstraction for a single Microsoft Information Protection label.

Member Function Documentation

GetActionSource()

virtual ActionSource Label::GetActionSource ( ) const

pure virtual

Gets the action source of the label.

Returns

Action source

GetAutoTooltip()

virtual const std::string & Label::GetAutoTooltip ( ) const

pure virtual

Get the tooltip description of the classification that cause this label to be applied.

Returns

a tooltip string.

GetChildren()

virtual const std::vector< std::shared_ptr< Label > > & Label::GetChildren ( ) const

pure virtual

Get the children labels of the current label.

Returns

a vector of shared pointers to labels.

GetColor()

virtual const std::string & Label::GetColor ( ) const

pure virtual

Get the color the label should be displayed.

Returns

color value the string format. "#RRGGBB" where each of RR, GG, BB is a hexadecimal 0-f.

GetContentFormats()

virtual const std::vector< std::string > & Label::GetContentFormats ( ) const

pure virtual

Gets content types.

Returns

The content types that the label can be applied to.

GetCustomSettings()

virtual const std::vector< std::pair< std::string, std::string > > & Label::GetCustomSettings ( ) const

pure virtual

Get the custom settings of a label.

Returns

a vector of key value pairs representing custom settings.

GetDescription()

virtual const std::string & Label::GetDescription ( ) const

pure virtual

Get the label description.

Returns

the label description.

GetDoubleKeyUrl()

virtual std::string Label::GetDoubleKeyUrl ( ) const

pure virtual

Gets the double key URL, if the label requires double key user defined protection.

Note

Will return empty string if the label does not use double key or if the label uses template protection.

Returns

The double key URL.

GetId()

virtual const std::string & Label::GetId ( ) const

pure virtual

Get the label ID.

Returns

the label ID.

GetName()

virtual const std::string & Label::GetName ( ) const

pure virtual

Get the label name.

Returns

the label name.

GetParent()

virtual std::weak_ptr< Label > Label::GetParent ( ) const

pure virtual

Get the parent label.

Returns

a weak pointer to the parent label if exists else an empty pointer.

GetSensitivity()

virtual int Label::GetSensitivity ( ) const

pure virtual

Get the Sensitivity of the label.

Returns

a numerical value. Higher value defines higher Sensitivity. Sub labels share the priority of their parent label so justification is never required when changing labels among them.

GetTooltip()

virtual const std::string & Label::GetTooltip ( ) const

pure virtual

Get the tooltip description of the label.

Returns

a tooltip string.

HasAdhocProtection()

virtual bool Label::HasAdhocProtection ( ) const

pure virtual

Gets whether the label is associated with a policy that applies adhoc protection.

Returns

True if adhoc protection will be applied by label. False if not.

HasDoNotForwardProtection()

virtual bool Label::HasDoNotForwardProtection ( ) const

pure virtual

Gets whether the label is associated with a policy that applies do not forward protection.

Returns

True if do not forward protection will be applied by label. False if not.

HasEncryptOnlyProtection()

virtual bool Label::HasEncryptOnlyProtection ( ) const

pure virtual

Gets whether the label is associated with a policy that applies encrypt only protection.

Returns

True if encrypt only protection will be applied by label. False if not.

HasRightsManagementPolicy()

virtual bool Label::HasRightsManagementPolicy ( ) const

pure virtual

Gets whether the label is associated with a policy that applies protection.

Returns

True if protection will be applied by label. False if not.

IsActive()

virtual bool Label::IsActive ( ) const

pure virtual

Gets a boolean signaling if the label is active.

Note

Only active labels can be applied. Inactive labels cannot be applied, and are used for display purposes only.

Returns

true if label is active, else false.

---

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

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