public interface ShareTypeRenderer
ShareType
s to render their representation on
the UI.Modifier and Type | Interface and Description |
---|---|
static class |
ShareTypeRenderer.RenderMode
Enumeration representing the modes that shared can be rendered in Javascript.
|
Modifier and Type | Method and Description |
---|---|
String |
getShareTypeEditor(JiraAuthenticationContext userCtx)
Return the HTML of the component that is used to configure the ShareType when necessary.
|
String |
getShareTypeLabel(JiraAuthenticationContext userCtx)
Return a string that can be used to differentiate the associated ShareType.
|
String |
getSimpleDescription(SharePermission permission,
JiraAuthenticationContext userCtx)
Return a simple text only description of the share.
|
Map<String,String> |
getTranslatedTemplates(JiraAuthenticationContext userCtx,
SharedEntity.TypeDescriptor<? extends SharedEntity> type,
ShareTypeRenderer.RenderMode mode)
Return map of key -> template that can be used to show a configured shares in Javascript.
|
boolean |
isAddButtonNeeded(JiraAuthenticationContext userCtx)
Return whether or not the component needs a button.
|
String |
renderPermission(SharePermission permission,
JiraAuthenticationContext userCtx)
Return HTML that shows the configured share.
|
String renderPermission(SharePermission permission, JiraAuthenticationContext userCtx)
permission
- the share to render.userCtx
- the context of the user calling this method.String getSimpleDescription(SharePermission permission, JiraAuthenticationContext userCtx)
permission
- the share to describe, containing permission params.userCtx
- the context of the user calling this method.String getShareTypeEditor(JiraAuthenticationContext userCtx)
userCtx
- the context of the user calling this method.boolean isAddButtonNeeded(JiraAuthenticationContext userCtx)
userCtx
- the context of the user calling this method.String getShareTypeLabel(JiraAuthenticationContext userCtx)
userCtx
- the context of the user calling this method.Map<String,String> getTranslatedTemplates(JiraAuthenticationContext userCtx, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
userCtx
- the context of the user calling this method.type
- the type of the shared entity .mode
- the mode that should be rendered.Copyright © 2002-2023 Atlassian. All Rights Reserved.