Package com.smartsheet.api.models
Class ReportPublish
- java.lang.Object
-
- com.smartsheet.api.models.ReportPublish
-
public class ReportPublish extends java.lang.ObjectThe ReportPublish object. Retruned by endpoints such as the- See Also:
- get sheet publish status
-
-
Constructor Summary
Constructors Constructor Description ReportPublish()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetReadOnlyFullAccessibleBy()Get who can see the published report.java.lang.StringgetReadOnlyFullDefaultView()Get the read only full default viewbooleangetReadOnlyFullEnabled()Get the current publish status of a reportjava.lang.BooleangetReadOnlyFullShowToolbar()Get the read only full show toolbar flagjava.lang.StringgetReadOnlyFullUrl()Get the URL of the published report.ReportPublishsetReadOnlyFullAccessibleBy(java.lang.String readOnlyFullAccessibleBy)Set parameter indicating who can see the published report.ReportPublishsetReadOnlyFullDefaultView(java.lang.String readOnlyFullDefaultView)Set the read only full default viewReportPublishsetReadOnlyFullEnabled(boolean readOnlyFullEnabled)If true, a rich version of the report is publishedReportPublishsetReadOnlyFullShowToolbar(java.lang.Boolean readOnlyFullShowToolbar)Set the read only full show toolbar flag
-
-
-
Method Detail
-
getReadOnlyFullEnabled
public boolean getReadOnlyFullEnabled()
Get the current publish status of a report- Returns:
- read only publish status
-
setReadOnlyFullEnabled
public ReportPublish setReadOnlyFullEnabled(boolean readOnlyFullEnabled)
If true, a rich version of the report is published- Parameters:
readOnlyFullEnabled- report publish status
-
getReadOnlyFullAccessibleBy
public java.lang.String getReadOnlyFullAccessibleBy()
Get who can see the published report. Only available when readOnlyFullEnabled = true- Returns:
- String containing "ALL" - anyone, "ORG" - owner organization members
-
setReadOnlyFullAccessibleBy
public ReportPublish setReadOnlyFullAccessibleBy(java.lang.String readOnlyFullAccessibleBy)
Set parameter indicating who can see the published report. Only valid when readOnlyFullEnabled = true.- Parameters:
readOnlyFullAccessibleBy- - valid options are "ALL" and "ORG"
-
getReadOnlyFullUrl
public java.lang.String getReadOnlyFullUrl()
Get the URL of the published report. Valid only if readOnlyFullEnabled = true.- Returns:
- String containing the URL of the published report.
-
getReadOnlyFullShowToolbar
public java.lang.Boolean getReadOnlyFullShowToolbar()
Get the read only full show toolbar flag- Returns:
- readOnlyFullShowToolbar
-
setReadOnlyFullShowToolbar
public ReportPublish setReadOnlyFullShowToolbar(java.lang.Boolean readOnlyFullShowToolbar)
Set the read only full show toolbar flag
-
getReadOnlyFullDefaultView
public java.lang.String getReadOnlyFullDefaultView()
Get the read only full default view- Returns:
- readOnlyFullDefaultView. Valid options are "GRID", "CARDS", "CALENDAR"
-
setReadOnlyFullDefaultView
public ReportPublish setReadOnlyFullDefaultView(java.lang.String readOnlyFullDefaultView)
Set the read only full default view- Parameters:
readOnlyFullDefaultView- Valid options are "GRID", "CARDS", "CALENDAR"- Returns:
- the ReportPublish
-
-