Package org.apereo.cas.configuration.model.support.slack

Class SlackMessagingProperties

java.lang.Object

org.apereo.cas.configuration.model.support.slack.SlackMessagingProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-notifications-slack")
public class SlackMessagingProperties
extends Object
implements Serializable

This is SlackMessagingProperties.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SlackMessagingProperties()

Method Summary

Modifier and Type	Method	Description
String	getApiToken()	To call a Slack Web API method to post messages, CAS needs to be initialized with a Slack API token.
String	getUsernameAttribute()	The name of the user attribute that would then be used as the slack username.
SlackMessagingProperties	setApiToken(String apiToken)	To call a Slack Web API method to post messages, CAS needs to be initialized with a Slack API token.
SlackMessagingProperties	setUsernameAttribute(String usernameAttribute)	The name of the user attribute that would then be used as the slack username.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SlackMessagingProperties

public SlackMessagingProperties()

Method Details

getApiToken

public String getApiToken()

To call a Slack Web API method to post messages, CAS needs to be initialized with a Slack API token. A token usually begins with xoxb- (bot token) or xoxp- (user token). You get them from each workspace that an app has been installed.

getUsernameAttribute

public String getUsernameAttribute()

The name of the user attribute that would then be used as the slack username. If the attribute is left blank, the default principal identifier is used. Note that in either case the final value is prefixed with @, but only if the prefix does not already exist. Multivalued attributes are supported.

setApiToken

public SlackMessagingProperties setApiToken(String apiToken)

To call a Slack Web API method to post messages, CAS needs to be initialized with a Slack API token. A token usually begins with xoxb- (bot token) or xoxp- (user token). You get them from each workspace that an app has been installed.

Returns:

this.

setUsernameAttribute

public SlackMessagingProperties setUsernameAttribute(String usernameAttribute)

The name of the user attribute that would then be used as the slack username. If the attribute is left blank, the default principal identifier is used. Note that in either case the final value is prefixed with @, but only if the prefix does not already exist. Multivalued attributes are supported.

Returns:

this.