https://fluidframework.com/assets/js/b3b707cf.e17c9273.js

1"use strict";(self.webpackChunkfluid_framework_website=self.webpackChunkfluid_framework_website||[]).push([[143],{140443:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"api/fluid-framework/isequenceintervalcollectionevents-interface","title":"ISequenceIntervalCollectionEvents Interface","description":"Change events emitted by IntervalCollections","source":"@site/versioned_docs/version-2/api/fluid-framework/isequenceintervalcollectionevents-interface.md","sourceDirName":"api/fluid-framework","slug":"/api/fluid-framework/isequenceintervalcollectionevents-interface","permalink":"/docs/v2/api/fluid-framework/isequenceintervalcollectionevents-interface","draft":false,"unlisted":false,"tags":[],"version":"2","frontMatter":{"title":"ISequenceIntervalCollectionEvents Interface","sidebar_label":"ISequenceIntervalCollectionEvents","displayed_sidebar":"docsSidebar"},"sidebar":"docsSidebar","previous":{"title":"ISequenceIntervalCollection","permalink":"/docs/v2/api/fluid-framework/isequenceintervalcollection-interface"},"next":{"title":"ISerializedInterval","permalink":"/docs/v2/api/fluid-framework/iserializedinterval-interface"}}');var r=i(886070),s=i(403793);const l={title:"ISequenceIntervalCollectionEvents Interface",sidebar_label:"ISequenceIntervalCollectionEvents",displayed_sidebar:"docsSidebar"},o=void 0,a={},d=[{value:"Call Signatures",id:"call-signatures",level:2},{value:"Call Signature Details",id:"call-signature-details",level:2}];function c(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Change events emitted by ",(0,r.jsx)(n.code,{children:"IntervalCollection"}),"s"]}),"\n",(0,r.jsxs)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:[(0,r.jsxs)(n.p,{children:["To use, import via ",(0,r.jsx)(n.code,{children:"fluid-framework/legacy"}),"."]}),(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})]}),"\n",(0,r.jsx)(n.h2,{id:"isequenceintervalcollectionevents-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"export interface ISequenceIntervalCollectionEvents extends IEvent\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Extends"}),": ",(0,r.jsx)(n.a,{href:"/docs/v2/api/fluid-framework/ievent-interface",children:"IEvent"})]}),"\n",(0,r.jsx)(n.h2,{id:"call-signatures",children:"Call Signatures"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Call Signature"}),(0,r.jsx)(n.th,{children:"Alerts"}),(0,r.jsx)(n.th,{children:"Return Type"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/v2/api/fluid-framework/isequenceintervalcollectionevents-interface#_call_-callsignature",children:'(event: "changeInterval", listener: (interval: SequenceInterval, previousInterval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined, slide: boolean) => void): void'})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Beta"})}),(0,r.jsx)(n.td,{children:"void"}),(0,r.jsxs)(n.td,{children:["This event is invoked whenever the endpoints of an interval may have changed. This can happen on: - local endpoint modification - ack of a remote endpoint modification - position change due to segment sliding (slides due to mergeTree segment deletion will always appear local) The ",(0,r.jsx)(n.code,{children:"interval"})," argument reflects the new values. ",(0,r.jsx)(n.code,{children:"previousInterval"})," contains transient ",(0,r.jsx)(n.code,{children:"ReferencePosition"}),"s at the same location as the interval's original endpoints. These references should be used for position information only. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change. ",(0,r.jsx)(n.code,{children:"slide"})," is true if the change is due to sliding on removal of position"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/v2/api/fluid-framework/isequenceintervalcollectionevents-interface#_call__1-callsignature",children:'(event: "addInterval" | "deleteInterval", listener: (interval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void'})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Beta"})}),(0,r.jsx)(n.td,{children:"void"}),(0,r.jsxs)(n.td,{children:["This event is invoked whenever an interval is added or removed from the collection. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/v2/api/fluid-framework/isequenceintervalcollectionevents-interface#_call__2-callsignature",children:'(event: "propertyChanged", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void'})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Beta"})}),(0,r.jsx)(n.td,{children:"void"}),(0,r.jsxs)(n.td,{children:["This event is invoked whenever an interval's properties have changed. ",(0,r.jsx)(n.code,{children:"interval"})," reflects the state of the updated properties. ",(0,r.jsx)(n.code,{children:"propertyDeltas"})," is a map-like whose keys contain all values that were changed, and whose values contain all previous values of the property set. This object can be used directly in a call to ",(0,r.jsx)(n.code,{children:"changeProperties"})," to revert the property change if desired. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/v2/api/fluid-framework/isequenceintervalcollectionevents-interface#_call__3-callsignature",children:'(event: "changed", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, previousInterval: SequenceInterval | undefined, local: boolean, slide: boolean) => void): void'})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Beta"})}),(0,r.jsx)(n.td,{children:"void"}),(0,r.jsxs)(n.td,{children:["This event is invoked whenever an interval's endpoints or properties (or both) have changed. ",(0,r.jsx)(n.code,{children:"interval"})," reflects the state of the updated endpoints or properties. ",(0,r.jsx)(n.code,{children:"propertyDeltas"})," is a map-like whose keys contain all values that were changed, and whose values contain all previous values of the property set. This object can be used directly in a call to ",(0,r.jsx)(n.code,{children:"changeProperties"})," to revert the property change if desired. 'previousInterval' contains transient ",(0,r.jsx)(n.code,{children:"ReferencePosition"}),"s at the same location as the interval's original endpoints. These references should be used for position information only. In the case of a property change only, this argument should be undefined. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"slide"})," is true if the change is due to sliding on removal of position."]})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"call-signature-details",children:"Call Signature Details"}),"\n",(0,r.jsx)(n.h3,{id:"_call_-callsignature",children:'(event: "changeInterval", listener: (interval: SequenceInterval, previousInterval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined, slide: boolean) => void): void'}),"\n",(0,r.jsxs)(n.p,{children:["This event is invoked whenever the endpoints of an interval may have changed. This can happen on: - local endpoint modification - ack of a remote endpoint modification - position change due to segment sliding (slides due to mergeTree segment deleti

1on will always appear local) The ",(0,r.jsx)(n.code,{children:"interval"})," argument reflects the new values. ",(0,r.jsx)(n.code,{children:"previousInterval"})," contains transient ",(0,r.jsx)(n.code,{children:"ReferencePosition"}),"s at the same location as the interval's original endpoints. These references should be used for position information only. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change. ",(0,r.jsx)(n.code,{children:"slide"})," is true if the change is due to sliding on removal of position"]}),"\n",(0,r.jsx)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,r.jsx)(n.h4,{id:"_call_-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:'(event: "changeInterval", listener: (interval: SequenceInterval, previousInterval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined, slide: boolean) => void): void;\n'})}),"\n",(0,r.jsx)(n.h3,{id:"_call__1-callsignature",children:'(event: "addInterval" | "deleteInterval", listener: (interval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void'}),"\n",(0,r.jsxs)(n.p,{children:["This event is invoked whenever an interval is added or removed from the collection. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change."]}),"\n",(0,r.jsx)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,r.jsx)(n.h4,{id:"_call__1-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:'(event: "addInterval" | "deleteInterval", listener: (interval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void;\n'})}),"\n",(0,r.jsx)(n.h3,{id:"_call__2-callsignature",children:'(event: "propertyChanged", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void'}),"\n",(0,r.jsxs)(n.p,{children:["This event is invoked whenever an interval's properties have changed. ",(0,r.jsx)(n.code,{children:"interval"})," reflects the state of the updated properties. ",(0,r.jsx)(n.code,{children:"propertyDeltas"})," is a map-like whose keys contain all values that were changed, and whose values contain all previous values of the property set. This object can be used directly in a call to ",(0,r.jsx)(n.code,{children:"changeProperties"})," to revert the property change if desired. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"op"})," is defined if and only if the server has acked this change."]}),"\n",(0,r.jsx)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,r.jsx)(n.h4,{id:"_call__2-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:'(event: "propertyChanged", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void;\n'})}),"\n",(0,r.jsx)(n.h3,{id:"_call__3-callsignature",children:'(event: "changed", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, previousInterval: SequenceInterval | undefined, local: boolean, slide: boolean) => void): void'}),"\n",(0,r.jsxs)(n.p,{children:["This event is invoked whenever an interval's endpoints or properties (or both) have changed. ",(0,r.jsx)(n.code,{children:"interval"})," reflects the state of the updated endpoints or properties. ",(0,r.jsx)(n.code,{children:"propertyDeltas"})," is a map-like whose keys contain all values that were changed, and whose values contain all previous values of the property set. This object can be used directly in a call to ",(0,r.jsx)(n.code,{children:"changeProperties"})," to revert the property change if desired. 'previousInterval' contains transient ",(0,r.jsx)(n.code,{children:"ReferencePosition"}),"s at the same location as the interval's original endpoints. These references should be used for position information only. In the case of a property change only, this argument should be undefined. ",(0,r.jsx)(n.code,{children:"local"})," reflects whether the change originated locally. ",(0,r.jsx)(n.code,{children:"slide"})," is true if the change is due to sliding on removal of position."]}),"\n",(0,r.jsx)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,r.jsx)(n.h4,{id:"_call__3-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:'(event: "changed", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, previousInterval: SequenceInterval | undefined, local: boolean, slide: boolean) => void): void;\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},403793:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>o});var t=i(830758);const r={},s=t.createContext(r);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);