3.1.5.1.1.2.3.1 st_wopi-action-values

Office

This simple type specifies all the well-known WOPI actions that a WOPI client and WOPI server support. It is important to note that while the following schema restricts this type, WOPI servers MUST NOT fail when they encounter additional values not included in this schema.

Enumeration Values:

view: An action that indicates that the WOPI client supports viewing the file type. All WOPI clients MUST support this action for all file types that they support.

edit: An action that indicates that the WOPI client supports editing the file type.

mobileview: An action that indicates that the WOPI client supports a view of the file type that is optimized for viewing on mobile devices such as cellular phones.

embedview: An action that indicates that the WOPI client supports a view of the file that can be embedded in a web page.

embededit: An action that indicates that the WOPI client supports an editable view of the file that can be embedded in a web page.

present: An action that indicates that the WOPI client supports a broadcast of the file. A broadcast is a special view that is driven by one or more presenters from a client for the purposes of being viewed by a set of attendees viewing in separate clients. The present action is associated with the URI used by presenters.

presentservice: An action that indicates the location of a broadcast endpoint for broadcast presenters. Interaction with the endpoint is described in [MS-OBPRS].

attendservice: An action that indicates the location of a broadcast endpoint for broadcast attendees. Interaction with the endpoint is described in [MS-OBPAS].

attend: An action that indicates that the WOPI client supports a broadcast of the file. A broadcast is a special view that is driven by one or more presenters from a client for the purposes of being viewed by a set of attendees viewing in separate clients. The attend action is associated with the URI used by attendees.

editnew: An action that indicates that the WOPI client supports the creation of a new file based on the file provided by the WOPI server. The newext and newprogid attributes defined by the ct_wopi-action complex type (see section 3.1.5.1.1.2.2.4) indicate the type of file that will result from invoking the editnew action.

imagepreview: An action that indicates that the WOPI client supports providing an image preview of the file type.

interactivepreview: An action that indicates that the WOPI client supports providing an interactive preview of the file type. For example, a smaller version of a presentation that a user can still advance from slide to slide.

formsubmit: An action that indicates that the WOPI client supports accepting changes to the file type via a form-style interface. For example, a user might be able to use this action to change the content of a workbook even if they did not have permission to use the edit action.

formedit: An action that indicates that the WOPI client supports editing the file type in a mode better suited to working with files that have been used to collect form data via the formsubmit action.

rest: An action that indicates that the WOPI client supports interacting with the file type via additional URL parameters that are specific to the file type in question.

preloadview: An action that indicates that the WOPI client supports preloading static content prior to using the view action.

preloadedit: An action that indicates that the WOPI client supports preloading static content prior to using the edit action.

rtc: An action that indicates the location of a real-time communication endpoint for the file type.

getinfo: An action that indicates that the WOPI client supports retrieving additional information about the WOPI client in relation to the file type.

The following W3C XML schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this simple type.

 <xs:simpleType name="st_wopi-action-values">
   <xs:restriction base="xs:string">
     <xs:enumeration value="view" />
     <xs:enumeration value="edit" />
     <xs:enumeration value="mobileview" />
     <xs:enumeration value="embedview" />
     <xs:enumeration value="embededit" />
     <xs:enumeration value="mobileclient" />
     <xs:enumeration value="present" />
     <xs:enumeration value="presentservice" />
     <xs:enumeration value="attend" />
     <xs:enumeration value="attendservice" />
     <xs:enumeration value="editnew" />
     <xs:enumeration value="imagepreview" />
     <xs:enumeration value="interactivepreview" />
     <xs:enumeration value="formsubmit" />
     <xs:enumeration value="formedit" />
     <xs:enumeration value="rest" />
     <xs:enumeration value="preloadview" />
     <xs:enumeration value="preloadedit" />
     <xs:enumeration value="rtc" />
     <xs:enumeration value="getinfo" />
   </xs:restriction>
 </xs:simpleType>
Show: