SASServer

public protocol SASServer : AnyObject

Public Interface to a SAS Server

Instances are acquired by calling SASManager.verifySASServer() or by calling SASManager.servers(). When a server is acquired by the SASManager API, it is retained and made available across program instances.

You can remove a SAS server by calling SASManager.removeSASServer().

Since

since 8.22

  • The descriptor for this server.

    Since

    since 8.33

    Declaration

    Swift

    var descriptor: SASServerDescriptor { get set }

  • Readable description of this server. A default description will be generated if one is not supplied.

    Since

    since 8.22

    Declaration

    Swift

    var description: String { get set }

  • A summary for this server for use in user interfaces. The name will be in the following format: username@myviyaserver.mycompany.com

    Note: this is different from description, as it will always be the username followed by an @ followed by the server address. description can be changed and is meant to be customizable by the user.

    Since

    since 2022.11.0

    Declaration

    Swift

    var addressWithUsername: String? { get }

  • The version string of Visual Analytics for this server.

    Since

    since 2022.11.0

    Declaration

    Swift

    var visualAnalyticsVersion: String? { get }

  • Indicates if the SASServer automatically generates section previews for this report.

    Since

    since 8.22

    Declaration

    Swift

    var generatesReportThumbnails: Bool { get set }

  • Connect to this server.

    Since

    since 8.22

    Declaration

    Swift

    func connect(_ completion: @escaping (_ error: NSError?) -> Void)

    Parameters

    completion

    Completion block for the connection. The error will be nil if the connection is successful.

  • An Array of the user’s subscribed reports.

    Since

    since 8.22

    Declaration

    Swift

    var subscribedReports: [SASReport] { get }

  • An Array of the user’s insights.

    Since

    since 2022.11.0

    Declaration

    Swift

    var insights: [SASInsight] { get }

  • A Boolean value that determines whether the user can view favorites.

    Since

    since 2022.11.0

    Declaration

    Swift

    var isViewFavoritesAllowed: Bool { get }

  • A Boolean value that determines whether the current user can add and remove favorite reports.

    Since

    since 2022.11.0

    Declaration

    Swift

    var isModifyFavoritesAllowed: Bool { get }

  • Get a report from its descriptor

    Since

    since 8.22

    Declaration

    Swift

    func getSubscribedReport(descriptor: SASReportDescriptor) -> SASReport?

    Parameters

    uniqueIdentifier

    identifier for this report.

    Return Value

    report (nil if descriptor is invalid)

  • Subscribes to a report from the server.

    Since

    since 8.22

    Declaration

    Swift

    func subscribe(descriptor: SASReportDescriptor, completion: @escaping (_ report: SASReport?, _ error: NSError?) -> Void)

    Parameters

    descriptor

    Descriptor for report.
    completion

    Callback for completion. either report or error will be nil.

  • Remove subscription to a report.

    Since

    since 8.22

    Declaration

    Swift

    func unsubscribe(descriptor: SASReportDescriptor)

    Parameters

    descriptor

    Descriptor for report.